Skip to content

AGENTS.md

Latest commit

 

History

History
34 lines (27 loc) · 1.56 KB

AGENTS.md

File metadata and controls

34 lines (27 loc) · 1.56 KB
Raw

packages/docs — developer documentation site

A Docusaurus site. Built as the blockly-docs Nx project; it is not released to npm.

Repo-wide conventions are in the root AGENTS.md.

Commands

Run from packages/docs/, or from the repo root as npm run build-docs.

npm start          # build the API reference, then serve the site locally
npm run build      # production build
npm run serve      # serve an already-built site
npm run clear      # clear the Docusaurus cache
npm run lint       # ESLint over docs/**/*.mdx
npm run lint-fix

Things to know

  • docs/reference/ is generated by TypeDoc during the Docusaurus build, and is gitignored. Never edit those files directly — fix the TSDoc in packages/blockly/core/ instead.
  • The reference is built from blockly_api.json, not from the current source. That file is a snapshot of the core library's API committed during a release, so the site documents the released API rather than whatever is on main. To preview your own TSDoc changes, run npm run reference:refresh to regenerate it locally — then leave it out of your commit, since only a release should update it.
  • Markdown and MDX here are linted, not Prettier-formatted. packages/docs/**/*.md and *.mdx are listed in .prettierignore and handled by ESLint with eslint-plugin-mdx instead, so npm run format will not touch them.
  • Prose wrapping is preserved rather than reflowed, so existing line breaks in prose are intentional — don't rewrap paragraphs you aren't otherwise changing.