docs: reorganize documentation and add sub-pages - #278
Open
zlzGithub-0801 wants to merge 1 commit into
Open
Conversation
Contributor
|
✅ OpenCodeReview: Review complete: 0 finding(s) across 3 selected item(s). |
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
Reorganize the Core Concepts and aenv CLI documentation into focused subpages.
Why
Several documentation pages had become too long and difficult to navigate. The CLI reference also needed to match the latest command implementation.
Related issue
N/A — no issue provided.
Scope and non-goals
Includes documentation structure, internal links, CLI parameter descriptions, and BuildKit template-build documentation. No runtime behavior, API, configuration, or storage format is changed.
Design and behavior changes
Documentation-only change. Core Concepts and CLI topics now use nested pages. User-facing template documentation focuses on commands, startup behavior, build capacity, and monitoring; worker lifecycle details are documented under Developer Internals.
Compatibility and operations
Validation
make fmtmake clippymake test-unitmake -C services test(required whenservices/changes)maketargetSkipped checks and reasons:
Code, generated protocol, service, integration, and benchmark checks were skipped because this PR changes documentation only.
Risks and reviewer notes
Low risk. Review the new navigation in
docs/src/SUMMARY.md, the template build documentation, and the relocated BuildKit internals.Checklist