SemianiakaVY/openpencil
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity
openpencil/packages/docs/AGENTS.md
Danila Poyarkov b0231927c5
docs: route contributors through per-domain guides and ship npm license text (#785) 
Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm.
2026-09-29 01:02:06 +04:00

1.4 KiB
Raw Blame History

Docs site

Published VitePress site. bun run docs:dev, bun run docs:build for fast checks, and bun run docs:build:production for deployment output. bun run check:docs runs the integrity checks in tools/docs/ plus check:authoring-reference.

  • Keep routes under /getting-started, /overview/**, /user-guide/**, /programmable/**, /reference/**, and /development/**; do not recreate /guide/**. Preserve moves in packages/docs/public/_redirects.
  • Link untranslated locale navigation to canonical English pages rather than adding placeholders.
  • packages/docs/development/roadmap.md tracks product direction, Figma compatibility gaps, raw metadata coverage, and the code map. packages/docs/development/testing.md is the canonical testing architecture. Explanations that would bloat an AGENTS.md belong under packages/docs/development/.
  • SDK pages embed the demos colocated with packages/vue primitives, derive API tables from source and JSDoc with vue-component-meta, and process examples with Twoslash so imports and types stay aligned with the public package API. The docs Tailwind entry scans those demos.
  • Generated authoring-reference copies under this site are checked, not edited; run bun run generate:authoring-reference (packages/core/AGENTS.md, Tools).
  • CI runs documentation integrity and the docs build for docs-only changes, not engine, browser, Storybook, or native suites (tools/AGENTS.md).