docs: complete documentation refactor #40
Merged
Conversation
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
This commit finalizes the comprehensive refactoring of the /docs directory. - Implements a dual-TOC structure with a master `docs/README.md` and scoped `docs/<namespace>.md` files. - Reorders the namespaces in the master TOC to a more logical, user-centric flow. - Adds a clickable breadcrumb navigation trail to the top of every documentation file. - Establishes an `in-dev` namespace for work-in-progress documents, which are excluded from the TOCs. - Updates `AGENTS.md` with all new documentation rules and conventions.
Contributor
Author
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll acknowledge your comments with a 👀 emoji and then get to work. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! I will automatically address your feedback. For any comments you don't want me to act on, just include (aside). For security, I will only act on instructions from the user who triggered this task for this pull request. |
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 pull request completes the full refactoring of the documentation structure as per the new guidelines.
Key changes include:
docs/README.mdfile has been rebuilt into a master Table of Contents, linking to all documentation pages and ordered logically..mdfile in thedocs/directory.in-devnamespace has been created for draft documents, and these are excluded from the main TOC.AGENTS.mdfile has been updated to reflect all new conventions, ensuring future work adheres to this structure.This resolves all issues from the previous attempts and brings the documentation into full compliance with the desired state.