Repository navigation
chore(repo): EN-first docs, AGENTS.md, config hardening, guards dedup - #10
Merged
Merged
Conversation
- Stage 1 docs-i18n: root README.md rewritten as English canonical, original preserved as README.zh-CN.md; docs/README.md rewritten as English index with docs/README.zh-CN.md mirror; fixed kimi-k2.5 sample drift and bare USE_ISOLATED_HOME/DEBUG aliases in guides. - Stage 2 config: new AGENTS.md (project manual, env canonical table, tool-safety, secrets, EN-first, commit/PR rules); .gitignore hardened (.env.*, coverage, IDE, .opencode, tgz, tsbuildinfo, custom-bin, host-deployments); examples/compose/Dockerfile completed with behavior-preserving defaults; removed ghost lint doc. - Stage 3 architecture: extracted src/utils/guards.ts (asRecord / toErrorMessage single source, 7 files deduped, variant-B kept in system/collector); new docs/architecture.md with extension points, no-touch list and roadmap. - Verified: typecheck + build green, 191 jest tests pass, docker compose config valid, no secrets in diff.
…ents in .env.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three staged workstreams, each fix-reviewed to PASS by dedicated review subagents (fix => review loops closed):
Stage 1 — docs-i18n (EN-first)
README.mdrewritten as English canonical; original preserved byte-identical asREADME.zh-CN.md(+ bidirectional language bars, Issues link added).docs/README.mdrewritten as English index (+ translation-status table, architecture row);docs/README.zh-CN.mdChinese mirror added.kimi-k2.5sample drift indocs/configuration.md; fixed bareUSE_ISOLATED_HOME/DEBUGenv aliases in guides (canonicalOPENCODE_*+ file-key notes).Stage 2 — AGENTS.md + env config + .gitignore
AGENTS.md: overview, stack/commands (no lint script), layout, env canonical table (env > file > default + known dual-entry drifts documented, not silently changed), tool-safety, secrets/prohibited, EN-first, commit/PR checklist..gitignorehardened:.env.*+!.env.example,coverage/, IDE,.opencode/, tgz, tsbuildinfo,custom-bin/,docs/host-deployments.md(migrated from local-only.git/info/excludeso it propagates on clone)..env.example/config.json.examplecompleted;docker-compose.yml/Dockerfilepass through missing vars with behavior-preserving defaults (BIND fold untouched); removed ghostnpm run lintdoc.Stage 3 — architecture (maintainability/extensibility)
src/utils/guards.ts(asRecord/toErrorMessagesingle source; 7 files deduped 7->1 / 6->3; variant-B intentionally kept insystem.ts/collector.tsper header note).docs/architecture.md: runtime shape, request template + intentional differences, extension points, no-touch list, unimplemented roadmap (preflight/stream-kit/withSessionRetry/config-unify).Verification
npm run typecheck+npm run buildgreennpm test -- --runInBand: 7 suites, 191 tests passdocker compose configvalid; added defaults matchindex.tsprod defaults.env/config.json/dist/custom-bin/host-deploymentsuntracked,.env.exampletracked