Reorder documentation namespaces for better logical flow #38
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
- Moves the content from individual workflow documentation files into the main `docs/README.md`. - Deletes the now-redundant individual workflow files. - Fixes a broken link to a non-existent prettier workflow document.
- Refactors the documentation in the `docs/` directory to use a two-level namespace structure. - `docs/README.md` is now a master Table of Contents linking to namespace index files. - Creates a top-level `namespace.md` file for each documentation category (e.g., `ai.md`, `community.md`). - Each `namespace.md` file contains an overview and links to the specific documentation pages within that namespace. - Updates `AGENTS.md` to include guidelines for the new documentation structure.
- Restructures `docs/README.md` to be a master Table of Contents, linking to all individual documentation pages, grouped by namespace. - Adds a quick-link navigation bar to the top of `docs/README.md`. - Ensures `docs/<namespace>.md` files serve as introductions and scoped TOCs for their respective namespaces. - Updates `AGENTS.md` to reflect the new dual-TOC documentation rules, instructing future agents to add links to both `README.md` and the relevant `namespace.md` file when adding new documentation.
- Reorders the namespaces in `docs/README.md` to follow a more logical, user-centric flow, from initial use to contribution and maintenance. - The new order is: Guides, Development, CI/CD, Publishing, Updating, Project Management, Community, AI, Documentation. - The quick-link navigation bar at the top of `docs/README.md` is also updated to reflect this new order. - This commit finalizes the documentation structure according to all the user's requirements.
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. |
- Reorders the namespaces in `docs/README.md` to follow a more logical, user-centric flow, from initial use to contribution and maintenance. - The new order is: Guides, Development, CI/CD, Publishing, Updating, Project Management, Community, AI, Documentation. - The quick-link navigation bar at the top of `docs/README.md` is also updated to reflect this new order. - Removes the redundant 'Documentation Index' link from `docs/README.md`. - This commit finalizes the documentation structure according to all the user's requirements.
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 change reorders the documentation namespaces in
docs/README.mdto provide a more logical and intuitive user journey, from initial project use to development and maintenance. The quick-link navigation bar and the main sections are now ordered to prioritize the most common user tasks. This completes the documentation refactoring task.