Refactor documentation structure: consolidate internals page - #454
Merged
Conversation
…st heading levels
…fallback + backend docs - Remove test/README.md and docs/README.md (content absorbed into dev/) - dev/RULES.md: add MCP fallback (§1), new Coverage section (§2), build command + local preview subsections (§3), update checklist - dev/philosophy/documentation.md: add Backend section (Documenter.jl vs DocumenterVitepress), update layout tree with .vitepress/ - dev/PHILOSOPHY.md, dev/PLAN.md: renamed/moved from philosophy/ root Co-Authored-By: Cascade <cascade@codeium.com>
…/CLAUDE - Remove dev/ directory (moved to control-toolbox/Handbook) - AGENTS.md: rewrite with generic layout, redirect Developer Resources to Handbook - CLAUDE.md: identical to AGENTS.md - README.template.md: enhance description of CTBase's foundational role - Add README.md in src/, ext/, test/, docs/ with package-specific context - All point to control-toolbox Handbook for conventions Co-Authored-By: Cascade <cascade@codeium.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
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.
This PR refactors the documentation structure to consolidate internal symbols into a single "Internals" page and adjusts heading levels for better hierarchy.
Changes
docs/api_reference.jlext/DocumenterReference/page_building.jl###instead of##to create proper hierarchy under module headers##instead of###for better visual structureBenefits