The source of classflowapi.com/en/docs — guides, API reference and SDK examples.
Live Site · API · SDKs · All Repos
This repository hosts the public developer documentation for ClassFlow. Everything here is plain Markdown, MIT-licensed, and rendered on classflowapi.com/en/docs. If you spot a typo, an outdated example, or a concept worth covering, send a PR — that's how this site stays sharp.
guides/ # Step-by-step tutorials, how-tos, recipes
reference/ # API reference and SDK reference fragments
guides/— narrative content. One topic per subdirectory; one file per page.reference/— terse, scannable reference. Generated content lives alongside hand-written notes.
Static-site tooling will be wired up shortly (VitePress is the leading candidate). Until then every page is plain Markdown viewable in any editor.
# Planned
npm install
npm run docs:devPRs welcome! When opening one:
- Place new tutorials under
guides/<topic>/. - Place API reference fragments under
reference/. - Markdown only — no proprietary formats.
- Examples should compile/run against the latest published SDKs.
- Prefer short, runnable snippets over long prose.
- If a guide depends on a feature that hasn't shipped, mark it
> 🚧 Preview — coming in v….
For larger restructuring (a new top-level section, a new doc theme), open an issue first.
- Voice: friendly but precise. Examples beat explanations.
- Line length: no hard wrap; let the reader's editor do it.
- Code fences: always specify the language (
```typescript,```bash, etc.). - Headings: sentence case (
## Quick start), not Title Case. - Links: relative within the repo (
[guide](../guides/auth.md)); absolute for outside.
classflow-api/api— Backend APIclassflow-api/sdks— Official SDKsclassflow-api/openclaw-skill— OpenClaw / MCP skillclassflow-api/portal— The portal that renders these docs
Documentation content is licensed under MIT. You are free to fork, translate, embed and redistribute — attribution appreciated.