Skip to content

docs: add CLI and configuration references - #33

Merged
minixalpha merged 2 commits into
mainfrom
docs/issue-32-user-docs
Sep 4, 2026
Merged

docs: add CLI and configuration references#33
minixalpha merged 2 commits into
mainfrom
docs/issue-32-user-docs

Conversation

@minixalpha

@minixalpha minixalpha commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add a bilingual user-documentation index with complete English and Chinese CLI and configuration references.
  • Document every current CLI option and default, task input modes, working-directory behavior, output channels, exit statuses, ATIF trajectory rules, and internal Event Journal storage.
  • Document configuration sources, supported variables, defaults, settings-file shape, precedence, and empty-value handling.
  • Keep both READMEs concise and aligned by replacing detailed reference material with getting-started guidance and direct links.
  • Record the user-facing documentation change in the 0.8.x changelog.

Validation

  • .venv/bin/pytest — 188 passed
  • All local Markdown links in the updated READMEs and new user documentation resolve.
  • git diff --check main...HEAD

Closes #32

@minixalpha
minixalpha merged commit 2b83097 into main Sep 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: move detailed CLI and configuration guidance out of README

1 participant