Skip to main content

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

This file scopes guidance to the docs/ subtree specifically. Read the repository-root CLAUDE.md first — it holds the full editorial workflow, frontmatter rules, style guide summary, and quality-check usage. The notes below cover only what changes when your working directory is docs/ itself, plus a map of this subtree.

Commands (run from this directory)

The quality-check scripts live one level up, in scripts/quality-checks/. Reference target files relative to docs/:

../scripts/quality-checks/run-all-checks.sh path/to/file.mdx --skip-spelling

To check every file at once, run from the repo root instead (--all already walks all of docs/):

cd .. && ./scripts/quality-checks/run-all-checks.sh --all --skip-spelling

The Docusaurus site (build, dev server) is configured at the repo root, not here — run npm --prefix .. start or npm --prefix .. run build, or cd .. first.

Structure of this subtree

  • recipes/, features/, frontend/, screenbased/ — the four content sections (how-to, what-is, developer guide, field reference). Each is flat within its own topic area; do not add further subdirectories beyond what already exists.
  • screenbased/app/ and screenbased/admincms/ — field-reference docs split by application. The helptag/slug frontmatter here is load-bearing for in-app help links; never change it on a page that is already published.
  • _templates/ — one starting template per content type: _recipestemplate.mdx, _featurestemplate.mdx, _apptemplate.mdx, _admincmstemplate.mdx, _widgettemplate.mdx, _indextemplate.mdx. Always start a new page from the matching template rather than an existing page.
  • _data/terminology.mdx, _data/product-names.mdx, _data/contractions.mdx — the source lists that check-terminology.sh, check-product-names.sh, and check-contractions.sh validate against. Update these when a new forbidden term, contraction, or product-name variant is identified, not just the prose style guide.
  • _style-guide.mdx — the authoritative style rules; the summary in the root CLAUDE.md is derived from this file. When the two disagree, this file wins.
  • glossary.mdx — canonical definitions for domain terms (for example Basket, never "cart"). Any new or renamed domain term used in a page should get a matching entry here.
  • Images referenced from anywhere in this subtree live under ../static/img/<section>/, not inside docs/, and are referenced with absolute paths (/img/<section>/filename.png).