0002 · Documentation baseline
English is authoritative; Chinese reference .
Status: documentation revision D2; reviews owner-waived for the dependency-policy amendment; initial commit awaits owner preview/confirmation. Local main is the one-time documentation-only initial-commit exception. No remote or PR exists. This baseline establishes a concise, auditable contribution process; website implementation remains a separate proposal
.
Review selection for this revision: all reviews for the D2 dependency-policy amendment are owner-waived, not passed. This selection does not apply to future tasks.
Requirements
- Require latest-stable verification when adding/upgrading direct dependencies and tools, exact version pins, locked transitive resolutions, and frozen CI installs. Compatibility exceptions require an owner decision.
- Deliver documentation and Apache-2.0 only. Keep README, collaboration rules, workflow and change records English-primary with Simplified Chinese references.
- Record each change in one article pair covering requirements, plan/decisions, execution and acceptance, with selected reviews inline. Retain material engineering rationale and verification, without conversation or clerical noise.
- Ask the owner which reviews to run before every new feature/independent change. All selected independent reviews check correctness, unnecessary complexity from first principles, maintainability, log value and privacy. Stop dependent work for unclear requirements or owner decisions.
- Use relative repository file references; keep private personal data, local absolute paths, credentials and raw sessions out of public documents and evidence.
- Require sibling worktrees from current main for later changes, PR-only integration, and an exact staged-file/message preview with owner confirmation before every commit. Use English Conventional Commits and bullet-point bodies for multiple substantive changes.
Acceptance requires five matching bilingual Markdown pairs plus LICENSE, valid local links, concise and consistent rules, no unnecessary attachments, and documentation-only checks reported accurately. Application tests, CI/CD, remote enforcement and deployment are outside this baseline.
Plan and decisions
- Define shared contributor and dependency-version rules in AGENTS and the practical steps in
docs/workflow.md; keep README as the short entry point. - Use one complete English article and Chinese reference per change. Keep the website proposal and this documentation baseline as distinct records because their delivery scopes differ.
- Check file inventory, links, bilingual meaning, whitespace and public-data hygiene. Apply the current review selection.
- Stage only the intended documentation/license, inspect the full staged diff, and show the exact file list and English message. Commit only after owner confirmation.
One article per change keeps decisions and evidence readable together. Separate stage files and mandatory snapshot/hash frameworks add navigation and maintenance without serving this baseline’s acceptance criteria. Reusable guides stay in docs/; attachments are optional when they add evidence. Future PR links and reviewed Git revisions provide traceability without duplicating repository history.
Selecting the latest stable release at addition/upgrade time and then pinning it keeps the baseline current while making subsequent installs reproducible. Transitive dependencies stay at their compatible lockfile resolutions.
Execution
- Shared version rules cover application packages, toolchains, Git dependencies and CI Actions. No dependency manifest, lockfile, installation or concrete version verification is part of this baseline.
- README provides the project status and document entry points; AGENTS and the workflow define task-specific review choices, first-principles review criteria, public-data rules, sibling worktrees and commit checkpoints.
- Each change record presents its effective requirements, technical choices, delivery status and acceptance in a bilingual article pair. The website proposal explicitly distinguishes planned behavior from delivered work.
- The baseline contains only the five document pairs and the standard Apache-2.0 LICENSE. No evidence attachment is needed for these text-only changes.
Acceptance
Run these checks from the repository root; Git status here describes the pre-commit checkpoint, not a permanent repository state.
| Check | Reproduction / expected result | Actual result |
|---|---|---|
| Scope | rg --files --hidden -g '!.git/**' -g '!.agents/**' -g '!.codex/**': only the inventory below | Passed: 11 files, five bilingual pairs |
| Language and links | Read each EN/ZH pair for equivalent rules; resolve every Markdown file link relative to its containing file | Passed: author checked semantic agreement; all 34 local links resolve |
| Formatting and privacy | Inspect the complete documents for trailing whitespace, local absolute paths, private personal data, credentials, private endpoints and raw sessions | Passed: no trailing whitespace; pattern scans and editorial inspection found no private data or local absolute paths |
| Git checkpoint | git branch --show-current is main; git rev-parse --verify HEAD fails before the initial commit; git remote is empty | Passed: main, no HEAD commit, no remote |
| Staged delivery | git diff --cached --check, then inspect the full staged diff and exact staged paths; stage matches the inventory and working files | Passed: exactly 11 staged additions, bytes match working files, no unstaged/untracked files, whitespace check passed |
Expected inventory: README.md / README.zh.md, AGENTS.md / AGENTS.zh.md, docs/workflow.md / docs/workflow.zh.md, logs/changes/0001-repository-bootstrap/index.md / index.zh.md, logs/changes/0002-documentation-baseline/index.md / index.zh.md, and LICENSE: 11 files, five bilingual pairs. The short Chinese article names in this list share the preceding English file’s directory.
No application tests, Hugo build, browser acceptance, remote-rule verification or deployment were performed. Those remain acceptance work for implementation.
Review record
2026-09-13 — independent reviewer final_documentation_review: PASS, no blocking findings. Scope: documentation revision D1, all 11 working files listed above. The review checked bilingual consistency, correctness, first-principles simplicity, log value, privacy and authorization boundaries, and independently reproduced the file/link/whitespace and Git-state checks.
The D1 pass does not cover D2 dependency-policy changes. No review was run for D2, as specified above. Author checks and staging verification use the acceptance criteria above; owner confirmation is still required before committing.