docs(developer-guide): add anolisa architecture, CLI reference, and testing guides#1387
Open
ralf003 wants to merge 1 commit into
Open
docs(developer-guide): add anolisa architecture, CLI reference, and testing guides#1387ralf003 wants to merge 1 commit into
ralf003 wants to merge 1 commit into
Conversation
…esting guides Add developer-guide documentation for the anolisa CLI component covering: - Architecture: 5-crate workspace layout, dependency graph, data flow, key design decisions (transaction journal, manifest v2, dual-mode install, adapter subsystem, crash safety) - CLI Reference: complete command/subcommand/flag reference with usage examples for all 18 leaf commands and 7 subcommand groups - Testing: test structure, conventions, platform-specific testing, and CI requirements This follows the documentation-standard.md convention that detailed reference material belongs in docs/developer-guide/ rather than in component README files.
Contributor
Author
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.
Summary
Add developer-guide documentation for the anolisa CLI component, following the project's documentation standard (
specs/documentation-standard.md).Background
PR #1039 added a detailed README for the anolisa component but was closed because technical reference material belongs in
docs/developer-guide/rather than in component README files. The upstream maintainer has since added a concise README.This PR adds the detailed technical documentation that was missing: architecture, CLI reference, and testing guides in
docs/developer-guide/en/anolisa/.Changes
docs/developer-guide/en/anolisa/architecture.mddocs/developer-guide/en/anolisa/cli-reference.md~/.config/anolisa/config.toml)docs/developer-guide/en/anolisa/testing.mdVerification
clapderive macros,Cargo.tomlmanifests, module declarations)