Documentation site information architecture
Source of truth lives in this GitHub repository under docs/; signalql.org publishes the same tree.
Top navigation
| Area | Purpose |
|---|---|
| Guide | Narrative docs (why, data model) |
| Spec | Current spec, scope, domain packs, and historical versions |
| Versions | Transparent language evolution index |
| Examples | Canonical analytics examples |
| AI | Grammar pack and prompting guide |
| Reference | AST schema, parser/adapters docs, query API contract |
| Integrations | Cursor, Claude, ChatGPT, MCP |
| Launch | Adoption brief and distribution checklist |
| Site | Information architecture and publishing |
Sidebar map
- Guide:
why-signalql,first-query,postgres-local,data-model - Specification:
spec/versions,spec/v0.5(+v0.5-object-model,v0.5-provenance,v0.5-context,v0.5-examples,v0.5-command-notes),spec/v0.4,spec/v0.4-roadmap,spec/v0.3,spec/v0.2,spec/scope,spec/domain-packs,spec/v0.1 - Integrations:
cursor,claude,chatgpt,mcp - Launch:
adoption-brief,distribution - Site:
information-architecture
GitHub → site publishing workflow
- Authors edit Markdown under
docs/on branches; review via PR. - CI runs
npm run docs:build(VitePress) on main. - Static output
docs/.vitepress/distdeploys to hosting (e.g. GitHub Pages, Cloudflare Pages) configured in.github/workflows/docs.yml.
Content stays versioned in Git; the published site is a build artifact of that tree.