Docs Improvement: Introduce Change Log System #4946
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gdjohnson
requested review from
jnaviask,
zakhap,
dillchen and
CowMuon
as code owners
jnaviask
approved these changes
Sep 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch introduces our new change log system, for tracking document status, to the wiki
ReadMe.This change log system has been briefly discussed in #4353, but not officially pitched to or approved by eng leads @CowMuon and @jnaviask. I'm opening this PR partially in the spirit of soliciting feedback and receiving an official OK.
However, it's also worth noting that, IMO, any top-down system like this will necessarily be a first draft, requiring ongoing tweaks and improvements over time as we gain experience & understanding of our docs system. (That is, any system we settle on will likely not be final.)
Link to Issue
Closes: #4913
Description of Changes