Skip to content

docs: complete bilingual reader rollout and documentation rules - #93

Merged
wefio merged 3 commits into
mainfrom
docs/documentation-writing-rollout
Oct 19, 2026
Merged

wefio merged 3 commits into
mainfrom
docs/documentation-writing-rollout

Conversation

@wefio

@wefio wefio commented Oct 19, 2026 •

Copy link
Copy Markdown
Owner

Change summary

What: Complete the reader-oriented bilingual documentation and terminology rollout, add continuous documentation-rule checks, and reconcile the existing documentation with current main.

Why: Keep English primary documents, Chinese companions, terminology owners and complete reading units aligned. Prevent missing companions, invalid structure and ambiguous terminology from silently returning, without replacing semantic review with green structural checks.

Changes:

  • Organize maintained documentation into complete bilingual topics, retaining conditions, exceptions, historical qualifications and inbound anchors.
  • Add union-based document-group discovery to docs:check, covering root README, docs/ and skills/, including orphan companions and missing primary files.
  • Keep glossary schema, severity, registered discovery scope and byte ceilings strict. Repair actual data/owner failures and the header/reciprocal-link parser defects, with regression tests.
  • Integrate main 1534e98acbdd93f037d128b5ee0ce8720abf3234; resolve all 48 documentation conflicts at their topic owners instead of discarding upstream facts. Complete 24 imported companion gaps.
  • Preserve current storage, filtering/binding, selected-evidence ordering, declaration recovery, test-resource and automatic waiting-budget facts. Keep retained source-only records explicitly historical.
  • Relative to main, non-document changes are exactly eight documentation checker/test files plus the package-owned documentation command. No runtime implementation or lockfile changes.

Current head: b6202e0c1527904cec3b7b21b9caedf2a960dbce. The preserved reviewed source branch is not pushed as unrelated feature history.

Verification

  • Documentation: 711 files, 0 errors, 0 warnings; 355 complete groups, 0 errors, one existing declared disposable scratch.
  • Glossary: 433 definitions, 0 errors.
  • Four focused suites: 108 passed, no failed/cancelled/skipped tests.
  • Eight owned TypeScript files: 0 LSP diagnostics; scoped ESLint/Prettier passed.
  • Fourteen non-installing static commands passed after the main merge, including build, package checks, types, lock consistency, lint, formatting, documentation, context, complexity, terminology, policy words and RTM inventory validation.
  • Full product suite: 1,894 cases — 1,892 passed, 0 failed/cancelled/todo, 2 declared GC skips.
  • Full mutation harness: 116/116 caught by the named tests, 23/23 targets restored byte-identically, no remaining lock.
  • PR diff whitespace check passed; main is an ancestor of HEAD; working tree clean and GitHub reports MERGEABLE.

The final commit adds only the bilingual verification note; documentation and glossary checks were rerun afterwards. Detailed dated evidence and qualifications are in the existing rollout audit.

Not verified

The complete local verify:static / agent:verify bundle was not rerun because its subpackage step invokes dependency installation. No local dependency installation was performed; the fourteen non-installing static commands and full product/mutation suites were run separately, not represented as a complete verifier receipt. CI's static/package contracts have passed.

At the final RCP observation for the current head, Static/package contracts, Product/coverage, Research characterization, Node 22 compatibility, CodeFactor and the aggregate All checks passed are all SUCCESS. Windows chaos is skipped by the event policy, not counted as executed. No deployment, live-provider workload, official benchmark rerun or end-to-end host-input acceptance is claimed. Historical limitations in retained reports remain scoped evidence, not additional unfinished items in the accepted documentation queue.

Completion checklist

Local quality checks

  • Documentation and glossary checks pass; non-trivial rule changes have owning decisions and regression tests.
  • Full product suite and the focused documentation suites pass with explicit skip accounting.
  • Non-installing static checks, LSP, formatting, lint and complexity checks pass.
  • Complete local installing verify:static / agent:verify bundle — intentionally not claimed.
  • Dependency and subpackage-change conditions are not applicable relative to main; lock consistency was checked.
  • Not-verified scope is declared; no generated build artifacts are committed.
  • Only owned documentation/rule changes are included; upstream runtime implementation is unchanged.

RCP and remote confirmation

  • In-flight repository-development goal registered before implementation.
  • PR/check state observed through nmg-rcp forge-status --pr 93 --json at the current head.
  • Static and package contracts passed in CI.
  • CodeFactor passed.
  • All required remote checks completed successfully; aggregate All checks passed is SUCCESS.

PR remains draft. No merge has been performed.

wefio added 3 commits October 19, 2026 14:38
Publish the reviewed documentation and terminology changes with their hygiene, size-budget and document-group checks. Keep runtime feature implementation out of this change.
Preserve upstream documentation facts at their bilingual topic owners, complete imported companion groups, and retain source-record boundaries. Runtime implementation remains identical to main.
@wefio
wefio marked this pull request as ready for review October 19, 2026 09:35
@wefio
wefio merged commit 91b2238 into main Oct 19, 2026
7 checks passed
wefio added a commit that referenced this pull request Oct 20, 2026
…bilingual rollout

#93 split design.md, completion-audit.md and hidden-features-registry.md into
subfiles with zh-CN and terms companions, so every conflict was documentation.
Resolution takes main's structure and re-homes this branch's own content:

- design/progressive-retrieval: Chinese recollection questions, lexical tie
  resolution before the direct cap and AG budget, session-only recall cue pilot
- design/incremental-storage-and-index-maintenance: access-pressure eligibility
- design/product-boundary/agent-cli-and-resident-service: controlled daemon reload
- completion-audit/requirement-matrix and hidden-features-registry/feature-register:
  event-record and controlled-reload rows
- decisions 2026-10-15-session-recall-cues and 2026-10-17-board-event-records:
  terms companions
- board-event-records plus five experiment records: zh-CN and terms companions
  required by the post-#93 document-group contract; the Chinese originals moved to
  .zh-CN.md and English text now sits on the canonical name

No source file conflicted; the code from this branch is unchanged by the merge.
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