Zfb Wisdom

zfb Documentation Reference

Look up documentation from the zfb (zudo-front-builder) project. Documentation base path: docs/src/content/docs (relative to repo root)

Mode Detection

Parse the argument string for flags:

• If args start with -u or --update: enter Update mode (see below)
• Otherwise: enter Lookup mode (default)

Strip the flag from the remaining argument to get the topic keyword.

Lookup Mode (default)

1. Find the relevant article(s) from the docs/ directory based on the topic
2. Read ONLY the specific article(s) you need — do NOT load all articles at once
3. For architecture questions, look under docs/architecture/ for the relevant page
4. Apply the information from the article when answering the user's question
5. Mention the source article path so the user can find it for further reading

Update Mode (-u / --update)

The user has new information and wants to add or update documentation in this repo.

Workflow

1. Understand the new info: Ask the user what they learned or want to document. The topic keyword (if provided) hints at the subject area.
2. Find existing docs: Search the docs/ directory for articles related to the topic. Read them to understand what is already covered.
3. Decide create vs update: If an existing article covers the topic, update it. Otherwise, create a new .mdx file in the appropriate subdirectory.
4. Write the content: Follow the doc-authoring rules in docs/CLAUDE.md:
   • Required frontmatter: title (string). Always set sidebar_position. Optional: description, sidebar_label, tags, etc.
   • Do NOT use # h1 in content — the frontmatter title renders as h1. Start with ## h2 headings.
   • Use available MDX components (<Note>, <Tip>, <Info>, <Warning>, <Danger>) where appropriate.
5. Update Japanese docs: Create or update the corresponding file under docs-ja/ mirroring the English directory structure. Keep code blocks and diagrams identical — only translate surrounding prose.
6. Format: From the repo root, run pnpm format:mdx to format changed Markdown/MDX files.
7. Verify: Run pnpm build inside docs/ to confirm the site builds correctly.

Documentation Structure

The documentation is organized in MDX files under docs/:

- api/
- architecture/
- changelog/
- claude-md/
- claude-skills/
- claude/
- concepts/
- getting-started/
- guides/
- install/
- markdown-features/
- recipes/

Browse the docs/ directory to discover available articles. Each .mdx file has YAML frontmatter with title and description fields that help identify the right article to read.

Japanese Documentation

Japanese translations are available under docs-ja/. When the user is working in Japanese or asks for Japanese content, prefer articles from docs-ja/.