Skip to content

docs(developer-guide): add anolisa architecture, CLI reference, and testing guides#1387

Open
ralf003 wants to merge 1 commit into
alibaba:mainfrom
ralf003:docs/anolisa-developer-guide
Open

docs(developer-guide): add anolisa architecture, CLI reference, and testing guides#1387
ralf003 wants to merge 1 commit into
alibaba:mainfrom
ralf003:docs/anolisa-developer-guide

Conversation

@ralf003

@ralf003 ralf003 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

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.md

  • 5-crate workspace layout and dependency graph
  • Per-crate responsibility table with all source modules
  • Complete directory layout (150+ files mapped)
  • Data flow diagrams: command dispatch, install, sandbox install (5-phase)
  • Key design decisions: transaction journal, manifest v2, dual-mode install, adapter subsystem, crash safety
  • Build profile configuration

docs/developer-guide/en/anolisa/cli-reference.md

  • 7 global flags with types and descriptions
  • All 18 leaf commands documented with args/flags tables
  • 7 subcommand groups (adapter, osbase kernel/sandbox/security, system, register, update)
  • Configuration file reference (~/.config/anolisa/config.toml)
  • Environment variables reference

docs/developer-guide/en/anolisa/testing.md

  • Test structure and organization
  • Running tests (cargo test, per-crate, CI check)
  • Test conventions (unit, integration, isolation)
  • Platform-specific testing (Linux gating)
  • Alinux CI environment spec
  • Writing new tests guide
  • PR pre-submission checklist

Verification

  • Documentation only — no code changes
  • All content verified against source code (clap derive macros, Cargo.toml manifests, module declarations)
  • Follows existing developer-guide conventions (cosh-ng, copilot-shell format)

…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.
@ralf003 ralf003 requested a review from casparant as a code owner July 7, 2026 15:49
@github-actions github-actions Bot added the scope:documentation ./docs/|./*.md|./NOTICE label Jul 7, 2026
@ralf003

ralf003 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

This PR picks up where #1039 left off. Per the documentation standard, detailed reference material that was originally placed in the component README now lives in docs/developer-guide/en/anolisa/. The concise README added in 82f8dab remains unchanged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:documentation ./docs/|./*.md|./NOTICE

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant