Skip to content

docs: streamline project documentation#118

Merged
kaiiiichen merged 2 commits into
mainfrom
codex/docs-streamline-documentation
Jul 26, 2026
Merged

docs: streamline project documentation#118
kaiiiichen merged 2 commits into
mainfrom
codex/docs-streamline-documentation

Conversation

@kaiiiichen

@kaiiiichen kaiiiichen commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace the bilingual, badge-heavy README with a concise English-only project overview
  • add DEVELOPMENT.md as the single technical reference for setup, configuration, architecture, routes, APIs, validation, and deployment
  • simplify contribution, agent, Claude, security, portfolio, environment, and pull request documentation
  • add .codex/README.md with repository-local Codex guidance
  • update the commit hook and agent policy so Codex commits use Co-authored-by: Codex <noreply@openai.com> and never add Claude
  • align page descriptions with the current live site and current implementation

Impact

Documentation is shorter, easier to scan, and less likely to drift because detailed development guidance now has one source of truth. Codex collaboration and commit-credit rules are now explicit and enforced by the repository hook. No runtime behavior changes.

Test plan

  • scanned tracked documentation for Chinese characters and stale bilingual anchors
  • checked all local Markdown link targets
  • validated the commit hook syntax and resulting commit trailers
  • verified both PR commits credit Codex and neither credits Claude
  • npm run lint
  • npm run typecheck
  • npm run test (23 tests)
  • npm run build (36 routes/pages generated)
  • reviewed the current live homepage, About, Projects, Music for Life, and Misc pages

@vercel

vercel Bot commented Jul 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
kaichen.dev Ready Ready Preview, Comment Jul 26, 2026 1:46am

@kaiiiichen
kaiiiichen marked this pull request as ready for review July 26, 2026 01:39
@kaiiiichen
kaiiiichen marked this pull request as draft July 26, 2026 01:43
@kaiiiichen kaiiiichen self-assigned this Jul 26, 2026
@kaiiiichen
kaiiiichen marked this pull request as ready for review July 26, 2026 01:44
kaiiiichen and others added 2 commits July 25, 2026 18:45
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
@kaiiiichen
kaiiiichen force-pushed the codex/docs-streamline-documentation branch from 118b397 to 8e11cd4 Compare July 26, 2026 01:45
@kaiiiichen
kaiiiichen merged commit 137aa35 into main Jul 26, 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