Skip to content

Commit 61314f2

Browse files
akoclaude
andcommitted
docs: propose unified documentation site (PostgreSQL-style)
Add proposal for a comprehensive docs site with: - 8-part structure (Tutorial, Language, Tools, IDE, Go Library, Statement Reference, Internals, Appendixes) - Per-statement reference pages (Synopsis/Description/Parameters/ Notes/Examples/See Also) - mdBook for website + Typst for PDF, shared Markdown source - GitHub Pages hosting, automatic deployment - Content sourcing plan from existing 119 markdown files Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 95649c4 commit 61314f2

2 files changed

Lines changed: 572 additions & 1 deletion

File tree

docs/11-proposals/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ Add read-only SHOW and DESCRIBE commands for Mendix document types that lack MDL
152152

153153
| Proposal | Status | Summary | Depends On |
154154
|----------|--------|---------|------------|
155-
| [LLM Training Docs](github-for-llms.md) | Proposed | Improve documentation for LLM training: examples, common mistakes, doc index ||
155+
| [Documentation Site](proposal-documentation-site.md) | Proposed | Unified docs site (mdBook + Typst PDF), PostgreSQL-style structure with tutorial, language guide, per-statement reference ||
156+
| [LLM Training Docs](github-for-llms.md) | Proposed | Improve documentation for LLM training: examples, common mistakes, doc index | Documentation Site |
156157
| [SDK Equivalence](SDK_EQUIVALENCE.md) | Reference | TypeScript SDK vs Go implementation gap analysis ||
157158
| [Missing Capabilities](PROPOSAL_missing_capabilities.md) | Reference | Analysis of unsupported document types (REST, JSON structures, import/export mappings) ||
158159
| [Case Study: MxGraphStudioDemo](CASE_STUDY_MxGraphStudioDemo.md) | Reference | Real-world project analysis showing MDL coverage gaps ||

0 commit comments

Comments
 (0)