docs(protocol): consolidate guides and update README index #6870
Closed
Sunny6889 wants to merge 5 commits into
Closed
docs(protocol): consolidate guides and update README index #6870Sunny6889 wants to merge 5 commits into
Sunny6889 wants to merge 5 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
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.
What does this PR do?
Gather the project's scattered docs under
docs/, give them consistent lower-case names, and surface them from a new README Documentation index.Why are these changes required?
METRICS_CHANGELOG.mdand the protobuf protocol doc sat outsidedocs/, mixed in with build files and proto sources.protocol/src/main/protos/had no indication they were outdated, risking readers trusting the wrong file.This PR has been tested by:
Follow up
Extra details