Design Token Lint

Type to search...

to open search from anywhere

/doc/src/content/CLAUDE.md

CLAUDE.md at /doc/src/content/CLAUDE.md

Path: doc/src/content/CLAUDE.md

CLAUDE.md — src/content

Bilingual Rule (EN + JA)

When adding or modifying any documentation page, always update both languages:

  • English: src/content/docs/<topic>/index.mdx
  • Japanese: src/content/docs-ja/<topic>/index.mdx

The JA directory mirrors the EN directory structure exactly. Every EN page has a corresponding JA page.

Translation Rules

  • Prose: Translate to Japanese
  • Code blocks: Keep identical to EN — do NOT translate comments, strings, or identifiers in code blocks
  • Frontmatter title and description: Translate
  • Frontmatter category, sidebar_position, tags: Keep identical to EN
  • Inline code (`): Keep identical
  • Link text: Translate
  • Link URLs: Keep identical (they resolve to the same page under the appropriate locale)

Use relative .md paths for cross-page links, not absolute /docs/... paths. The remark-resolve-markdown-links plugin rewrites .md/.mdx extensions and applies the base prefix; bare absolute paths bypass it.

<!-- Good — relative path from guide/configuration/ to reference/methodology/ -->
See the [methodology](../../reference/methodology/index.md) page.

<!-- Bad — breaks under settings.base -->
See the [methodology](/docs/reference/methodology) page.

External links (https://...) pass through unchanged.

Frontmatter Schema

---
title: Page Title
description: Short SEO/sidebar description
sidebar_position: 1
category: guide
---
  • title (required)
  • description (optional but recommended)
  • sidebar_position (optional, controls order within a category)
  • category (optional, groups pages in the sidebar and matches headerNav.categoryMatch)
  • tags (optional array)
  • draft (optional boolean — excluded from production builds)

Categories and Header Nav

Categories used in this project (match settings.headerNav.categoryMatch in src/config/settings.ts):

  • overview — What is?, Getting Started
  • playground — Playground
  • guide — Configuration, CLI, Ignore Syntax, Examples
  • reference — API, Methodology
  • changelog — Changelog
  • claude — auto-generated

Adding a new category requires updating headerNav in src/config/settings.ts.

Auto-generated Content

src/content/docs/claude/, src/content/docs/claude-md/, src/content/docs-ja/claude/, and src/content/docs-ja/claude-md/ are auto-generated by the claude-resources integration on every build. They are gitignored. Do not hand-edit them.

Edit this page

Revision History