docs: improve documentation discoverability - #451
Open
devorun wants to merge 1 commit into
Open
Conversation
- Link the docs/ set from the top-level README so the architecture, security-model, checkpointing, and deposits/withdrawals guides are reachable from the entry point. - List the existing running-local-network guide in the docs index; it was the only page under docs/ missing from the table of contents. - Drop the stray duplicate top-level "# WIP" heading. The work-in-progress status is already stated in the Status section.
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
1 participant
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.
The
docs/folder has a thorough set of guides, but they aren't reachable from the project's entry points. This makes a few small, purely-documentation fixes so the existing docs are discoverable:docs/from the top-level README. The README had no pointer to the documentation set, so the architecture, security-model, checkpointing, and deposits/withdrawals guides were only findable by browsing the tree. Added a short Documentation section linking to them.docs/running-local-network.mdwas the only page underdocs/missing fromdocs/README.md's table of contents. Added it under the operational guides.# WIPheading in the README. It rendered as a second top-level#heading above# Summit; the work-in-progress status is already stated in the Status section.No source or behavior changes. All added links point to files that already exist in the repo.