Skip to content

Commit 3aa5aeb

Browse files
authored
AgentGuard Docs (#618)
* update * update docker to C
1 parent 65345eb commit 3aa5aeb

4 files changed

Lines changed: 590 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## What This Repo Is
6+
7+
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).
8+
9+
## Commands
10+
11+
```bash
12+
yarn start # Dev server at http://localhost:3030 (with polling)
13+
yarn build # Build to build/ directory
14+
yarn run spellcheck # Spell check docs
15+
yarn run rest-doc # Regenerate REST API docs from swagger.yaml via redocly
16+
yarn run llmstxt # Regenerate static/llms.txt and static/llms-full.txt
17+
```
18+
19+
**Tools (run from repo root with bun):**
20+
```bash
21+
bun tools/list-pages.ts # Show nav tree from sidebars.js + doc titles
22+
bun tools/missing.js # Docs files not referenced in sidebars.js
23+
bun tools/list-functions.ts # List all function names from functions_for_*.md
24+
sh tools/autogenerate-downloads.sh # Regenerate release-downloads.md from S3
25+
```
26+
27+
## Architecture
28+
29+
**Content:** All docs are in `docs/` as `.md` or `.mdx` files. File names map to URL slugs. Mermaid diagrams are supported natively.
30+
31+
**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`.
32+
33+
**Sidebar structure (top-level categories):**
34+
- OVERVIEW → GET STARTED → CONNECT DATA IN → TRANSFORM DATA → STORE & SERVE DATA → SEND DATA OUT → SQL REFERENCE → TIMEPLUS PROTON (OSS) → INTEGRATIONS → DEPLOYMENT → TROUBLESHOOTING → RELEASES
35+
36+
**Custom components:** `src/components/` contains reusable JSX components (Grid, Quickstart, TimeplusWatermarkVisualization). The `src/theme/DocSidebarItem/` override customizes sidebar rendering.
37+
38+
**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.
39+
40+
**Spellchecker config:** `tools/spellchecker/config.yml` (custom word lists for Timeplus-specific terms).

0 commit comments

Comments
 (0)