Repository Guidelines

April 13, 2026 ยท View on GitHub

This page is the documentation-site entry for repository development workflow.

The canonical source of truth remains AGENTS.md at the repository root in a local clone. Use this page when you are browsing the published docs site, and use AGENTS.md when you are working inside the repository itself.

Source Of Truth

When instructions overlap, use this order:

  1. AGENTS.md at the repository root
  2. package.json scripts and docs/Makefile
  3. .github/workflows/*.yml
  4. Supporting pages under docs/development/

What This Covers

  • Supported local environment
  • Repository boundaries for code vs. scratch content
  • Validation commands before review
  • Collaboration expectations in a shared worktree
  • Database migration expectations
  • API route responsibilities
  • Agent and deep-research development expectations
  • Documentation update requirements

Workflow Overview

:alt: English overview of the developer workflow from FigJam
:class: workflow-overview-en

:alt: Chinese overview of the developer workflow from FigJam
:class: workflow-overview-zh
  • Read Contributing for the default branch, commit, and PR workflow.
  • Read Collaboration before working in a dirty tree, coordinating with another contributor, or handing work to automation.
  • Read Agent Development before changing prompts, tools, streaming behavior, deep-research workflow logic, or other agent-facing contracts.

Next Pages