Skip to content

Contributor guides

Content, development and deployment instructions.

Keep docs/ flat while it contains a small set of maintained guides. English files are authoritative; matching .zh.md files are Chinese references. _index.md / _index.zh.md provide this directory map and the OINK section page.

GuideResponsibility
DevelopmentInstall the environment/dependencies, start/stop local servers, run checks and inspect builds.
WorkflowWorktrees, selected reviews, documentation ownership, acceptance and commit/PR rules.
ContentMarkdown schemas, translation pairs, adding content and draft publication.
DeploymentGitHub/Cloudflare configuration, production release, verification and rollback.

Put durable reusable instructions here and update their existing topic page when behavior changes. Add a new guide only for a distinct recurring topic; introduce subdirectories only when several related guides need grouping. Keep requirements, decisions, reviews and concise evidence in logs/changes/<id>/index.md and index.zh.md. Temporary Chinese acceptance handbooks belong only in ignored .local/acceptance/<id>.md, outside this published directory.