This repository is a Nuxt-based documentation site for ZKsync. Use this file as the entrypoint, then follow referenced files for detailed rules.
- Manual AI mode (no issue labels/workflow):
- Follow
agent/*guidance and execute tasks directly in this repo.
- Follow
- Automation mode (issue/label driven):
- Follow
internal/automation/*plusagent/*.
- Follow
- Global operating model: internal/automation/overview.md
- Triage process: internal/automation/triage.md
- Label taxonomy: internal/automation/labels.md
- Agent policy and scope: agent/POLICY.md
- Source and citation rules: agent/SOURCES.md
- Writing and formatting rules: agent/STYLE_GUIDE.md
- IA placement rules: agent/IA.md
- Terminology: agent/GLOSSARY.md
- Request template: .github/ISSUE_TEMPLATE/docs_request.yml
- Triage checklist: ISSUE_TRIAGE.md
- Keep diffs minimal and task-scoped.
- Do not invent technical facts, APIs, versions, or flags.
- Back factual claims with sources, or mark
TODO: verify. - Keep terminology consistent with
agent/GLOSSARY.md. - Merge stays manual.
- Install dependencies once:
bun install --frozen-lockfile - Markdown lint:
bun run lint:markdown - Prettier check:
bun run lint:prettier - Spell check:
bun run lint:spelling - ESLint:
bun run lint:eslint - Build:
bun run build - Full local gate:
bun run ci:check
- Docs content only (
content/**): runlint:markdown,lint:spelling, andlint:prettier. - Docs + assets (
public/**): run docs checks andbun run build. - Any code/config/workflow change: run
bun run ci:checkandbun run build. - Before opening a PR: run
bun run ci:checkandbun run build.
- Classify task (
new,update,fix,migrate). - Apply scope rules from
agent/POLICY.md. - Gather sources and citation evidence from
agent/SOURCES.md. - Place content using
agent/IA.md. - Write/edit using
agent/STYLE_GUIDE.mdandagent/GLOSSARY.md. - Run the required local checks.
- Prepare PR notes with source list, uncertainty list, and check results.
If you are using issue-driven automation, start with: