Skip to content

docs: refactor README onboarding - #53

Merged
pDJJq merged 3 commits into
mainfrom
refactor-readme
Aug 27, 2026
Merged

docs: refactor README onboarding#53
pDJJq merged 3 commits into
mainfrom
refactor-readme

Conversation

@pDJJq

@pDJJq pDJJq commented Aug 27, 2026

Copy link
Copy Markdown
Member

Summary

  • Rework the English and Chinese READMEs around product value, executable 60-second starts, daily retrieval, and safety boundaries.
  • Separate judgment-bearing Agent workflows from the deterministic runtime CLI.
  • Move the portable AGENTS.md integration contract into a focused reference document.
  • Sync llmdoc release knowledge with the new document owner and the official-host documentation review invariant.

Verification

  • npm run typecheck
  • npm run lint
  • npm test
  • npm run build
  • npm run validate:dogfood
  • npm run check:prompts
  • node scripts/check-codex-surface.mjs
  • npx -y markdownlint-cli2 README.md README.zh-CN.md docs/agent-integration.md
  • Bilingual command parity, local link resolution, and README CLI examples verified

@pDJJq
pDJJq merged commit 46d5dd8 into main Aug 27, 2026
4 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.

1 participant