docs: restructure navigation into five top-level sections (Start / Build / Operate / Security / Internals)#31
Merged
Merged
Conversation
Reorganize the documentation IA into the review's five top-level sections: Start, Build, Operate, Security, Internals. Every existing page keeps its on-disk path (get-started/, concepts/, guides/, reference/, desktop/, ecosystem/); only the nav grouping changes, so all content, cross-links, and page-path-based tests are preserved. Section mapping: - Start: install, first success, quickstart (get-started + desktop/install) - Build: record -> compile -> lint -> certify, effect verifiers, identity - Operate: run, halt/teach, on-prem, hosted lifecycle, monitoring - Security: qualification/claims, trust boundary, PHI/data handling - Internals: architecture, package/repository registry, docs governance validate_docs.py's package-catalog guard now accepts the ecosystem catalog under the renamed Internals section (previously hardcoded "Reference"), preserving its no-package-first-IA intent. mkdocs build --strict, validate_docs, and all 64 tests pass. Co-Authored-By: Claude Fable 5 <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
Reorganizes
docs.openadapt.aiinto the review's five top-level sections and relinks the nav accordingly. This is an organize-what-exists change — no page content was rewritten and no new docs were invented.Five-section structure
desktop/install, first-workflow, what-you-getNotes
scripts/validate_docs.py's package-catalog guard previously required the ecosystem catalog under a section literally namedReference; it now acceptsReferenceorInternals, keeping the no-package-first-IA intent while matching the new section name.Gates
mkdocs build --strict— passpython scripts/validate_docs.py— "Validation passed!"pytest tests/— 64 passed