AgentGuard Docs

CLAUDE.md

@@ -0,0 +1,40 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What This Repo Is
+
+Timeplus product documentation built with [Docusaurus v3](https://docusaurus.io/). Content lives in `docs/` as Markdown/MDX files. The site is deployed to docs.timeplus.com via Netlify. English is the only active locale (i18n scaffolding exists for Chinese but is disabled).
+
+## Commands
+
+```bash
+yarn start          # Dev server at http://localhost:3030 (with polling)
+yarn build          # Build to build/ directory
+yarn run spellcheck # Spell check docs
+yarn run rest-doc   # Regenerate REST API docs from swagger.yaml via redocly
+yarn run llmstxt    # Regenerate static/llms.txt and static/llms-full.txt
+```
+
+**Tools (run from repo root with bun):**
+```bash
+bun tools/list-pages.ts         # Show nav tree from sidebars.js + doc titles
+bun tools/missing.js            # Docs files not referenced in sidebars.js
+bun tools/list-functions.ts     # List all function names from functions_for_*.md
+sh tools/autogenerate-downloads.sh  # Regenerate release-downloads.md from S3
+```
+
+## Architecture
+
+**Content:** All docs are in `docs/` as `.md` or `.mdx` files. File names map to URL slugs. Mermaid diagrams are supported natively.
+
+**Navigation:** `sidebars.js` defines the complete sidebar hierarchy. When adding a new doc, you must add an entry to `sidebars.js` or it will appear in `bun tools/missing.js` output. URL redirects for renamed/moved pages are configured in the `plugin-client-redirects` section of `docusaurus.config.js`.
+
+**Sidebar structure (top-level categories):**
+- OVERVIEW → GET STARTED → CONNECT DATA IN → TRANSFORM DATA → STORE & SERVE DATA → SEND DATA OUT → SQL REFERENCE → TIMEPLUS PROTON (OSS) → INTEGRATIONS → DEPLOYMENT → TROUBLESHOOTING → RELEASES
+
+**Custom components:** `src/components/` contains reusable JSX components (Grid, Quickstart, TimeplusWatermarkVisualization). The `src/theme/DocSidebarItem/` override customizes sidebar rendering.
+
+**REST API docs:** Generated from `swagger.yaml` via `redocly` into `static/rest.html`. The source `swagger.yaml` is generated by the Neutron service (`make gen_api_doc`) — not stored in this repo.
+
+**Spellchecker config:** `tools/spellchecker/config.yml` (custom word lists for Timeplus-specific terms).