SemianiakaVY/openpencil
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity
openpencil/packages/docs/AGENTS.md
Danila Poyarkov 1aa10a4fed
build(tools): group tools by role and gate them like the rest of the repo (#791) 
Tools live under tools/<role>/<domain> (checks, generate, release, ci, dev), every tool is a workspace named @open-pencil/<domain>-tools, a shared tools/tsconfig.json backs the new check:tools gate that fixed 55 latent type errors, test:tools runs through bun --filter, the placement check is its own checks/test-homes package, and every tool resolves the repository through resolveWorkspaceRoot. Bun, Node, and mdast types live in a tools-root workspace so they never reach the app program.
2026-09-30 05:00:31 +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/checks/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).