Skip to content

Commit bc5cfc6

Browse files
akoclaude
andcommitted
docs: add mdBook documentation site with skeleton and migrated content
Set up docs-site/ using mdBook with 233 content pages across 8 parts (Preface, Tutorial, MDL Language, Project Tools, IDE Integration, Go Library, Statement Reference, Architecture/Internals, Appendixes). Migrated existing content from docs/ into the new structure: - Preface from mxcli-overview.md and README.md - Language reference from mdl-specification/ (17 pages) - Go Library from GO_LIBRARY.md (6 pages) - Internals from ARCHITECTURE.md and parser/BSON docs (7 pages) - Appendixes from MDL_QUICK_REFERENCE.md and data-types.md (4 pages) Remaining pages are stubs to be filled in (Tutorial, Tools, IDE, Statement Reference). Includes GitHub Actions workflow for deploying to GitHub Pages on merge to main. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 528f7da commit bc5cfc6

File tree

160 files changed

+5729
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+5729
-0
lines changed

.github/workflows/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs-site/**'
8+
- '.github/workflows/docs.yml'
9+
pull_request:
10+
branches: [main]
11+
paths:
12+
- 'docs-site/**'
13+
- '.github/workflows/docs.yml'
14+
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
30+
- name: Install mdBook
31+
run: |
32+
MDBOOK_VERSION="0.5.2"
33+
curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz" \
34+
| tar -xz -C /usr/local/bin
35+
36+
- name: Build book
37+
run: mdbook build docs-site
38+
39+
- name: Upload artifact
40+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: docs-site/book
44+
45+
deploy:
46+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
47+
needs: build
48+
runs-on: ubuntu-latest
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
steps:
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

docs-site/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book/

docs-site/book.toml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[book]
2+
title = "mxcli Documentation"
3+
description = "Documentation for mxcli and the MDL (Mendix Definition Language)"
4+
authors = ["Mendix Labs"]
5+
language = "en"
6+
src = "src"
7+
8+
[build]
9+
build-dir = "book"
10+
11+
[output.html]
12+
default-theme = "light"
13+
preferred-dark-theme = "navy"
14+
git-repository-url = "https://github.com/mendixlabs/mxcli"
15+
edit-url-template = "https://github.com/mendixlabs/mxcli/edit/main/docs-site/src/{path}"
16+
site-url = "/mxcli/"
17+
additional-css = ["theme/custom.css"]
18+
19+
[output.html.search]
20+
enable = true
21+
limit-results = 30
22+
boost-hierarchy = 2
23+
24+
[output.html.fold]
25+
enable = true
26+
level = 1

docs-site/src/SUMMARY.md

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
# Summary
2+
3+
[Preface](preface/README.md)
4+
- [What is mxcli?](preface/what-is-mxcli.md)
5+
- [What is MDL?](preface/what-is-mdl.md)
6+
- [Mendix Concepts for Newcomers](preface/mendix-concepts.md)
7+
- [Document Conventions](preface/conventions.md)
8+
9+
---
10+
11+
# Part I: Tutorial
12+
13+
- [Setting Up](tutorial/setup.md)
14+
- [Installation](tutorial/installation.md)
15+
- [Opening Your First Project](tutorial/opening-project.md)
16+
- [The REPL](tutorial/repl.md)
17+
- [Exploring a Project](tutorial/exploring.md)
18+
- [SHOW MODULES, SHOW ENTITIES](tutorial/show-commands.md)
19+
- [DESCRIBE, SEARCH](tutorial/describe-search.md)
20+
- [SHOW STRUCTURE](tutorial/show-structure.md)
21+
- [Your First Changes](tutorial/first-changes.md)
22+
- [Creating an Entity](tutorial/create-entity.md)
23+
- [Creating a Microflow](tutorial/create-microflow.md)
24+
- [Creating a Page](tutorial/create-page.md)
25+
- [Validating with mxcli check](tutorial/validation.md)
26+
- [Working with AI Assistants](tutorial/ai-assistants.md)
27+
- [Claude Code Integration](tutorial/claude-code.md)
28+
- [Cursor / Continue.dev / Windsurf](tutorial/other-ai-tools.md)
29+
- [Skills and CLAUDE.md](tutorial/skills.md)
30+
- [The MDL + AI Workflow](tutorial/mdl-ai-workflow.md)
31+
32+
---
33+
34+
# Part II: The MDL Language
35+
36+
- [MDL Basics](language/basics.md)
37+
- [Lexical Structure](language/lexical-structure.md)
38+
- [Qualified Names](language/qualified-names.md)
39+
- [Comments and Documentation](language/comments.md)
40+
- [Script Files](language/script-files.md)
41+
- [Data Types](language/data-types.md)
42+
- [Primitive Types](language/primitive-types.md)
43+
- [Constraints](language/constraints.md)
44+
- [Enumerations](language/enumerations.md)
45+
- [Type Mapping](language/type-mapping.md)
46+
- [Domain Model](language/domain-model.md)
47+
- [Entities](language/entities.md)
48+
- [Attributes and Validation Rules](language/attributes.md)
49+
- [Associations](language/associations.md)
50+
- [Generalization](language/generalization.md)
51+
- [Indexes](language/indexes.md)
52+
- [ALTER ENTITY](language/alter-entity.md)
53+
- [Microflows and Nanoflows](language/microflows.md)
54+
- [Structure](language/microflow-structure.md)
55+
- [Activity Types](language/activity-types.md)
56+
- [Control Flow](language/control-flow.md)
57+
- [Expressions](language/expressions.md)
58+
- [Nanoflows vs Microflows](language/nanoflows.md)
59+
- [Common Patterns](language/microflow-patterns.md)
60+
- [Pages](language/pages.md)
61+
- [Page Structure](language/page-structure.md)
62+
- [Widget Types](language/widget-types.md)
63+
- [Data Binding](language/data-binding.md)
64+
- [Snippets](language/snippets.md)
65+
- [ALTER PAGE / ALTER SNIPPET](language/alter-page.md)
66+
- [Common Patterns](language/page-patterns.md)
67+
- [Security](language/security.md)
68+
- [Module Roles and User Roles](language/roles.md)
69+
- [Entity Access](language/entity-access.md)
70+
- [Microflow, Page, and Nanoflow Access](language/document-access.md)
71+
- [GRANT / REVOKE](language/grant-revoke.md)
72+
- [Demo Users](language/demo-users.md)
73+
- [Navigation and Settings](language/navigation.md)
74+
- [Navigation Profiles](language/navigation-profiles.md)
75+
- [Home Pages and Menus](language/home-pages.md)
76+
- [Project Settings](language/project-settings.md)
77+
- [Workflows](language/workflows.md)
78+
- [Workflow Structure](language/workflow-structure.md)
79+
- [Activity Types](language/workflow-activities.md)
80+
- [Workflow vs Microflow](language/workflow-vs-microflow.md)
81+
- [Business Events](language/business-events.md)
82+
- [Event Services](language/event-services.md)
83+
- [Publishing and Consuming Events](language/pub-sub-events.md)
84+
85+
---
86+
87+
# Part III: Project Tools
88+
89+
- [Code Navigation](tools/code-navigation.md)
90+
- [SHOW CALLERS / CALLEES](tools/callers-callees.md)
91+
- [SHOW REFERENCES / IMPACT](tools/references-impact.md)
92+
- [SHOW CONTEXT](tools/show-context.md)
93+
- [Full-Text Search](tools/search.md)
94+
- [Catalog Queries](tools/catalog.md)
95+
- [REFRESH CATALOG](tools/refresh-catalog.md)
96+
- [Available Tables](tools/catalog-tables.md)
97+
- [SQL Queries](tools/catalog-sql.md)
98+
- [Use Cases](tools/catalog-use-cases.md)
99+
- [Linting and Reports](tools/linting.md)
100+
- [Built-in Rules](tools/builtin-rules.md)
101+
- [Starlark Rules](tools/starlark-rules.md)
102+
- [Writing Custom Rules](tools/custom-rules.md)
103+
- [mxcli lint](tools/mxcli-lint.md)
104+
- [mxcli report](tools/mxcli-report.md)
105+
- [Testing](tools/testing.md)
106+
- [Test Formats](tools/test-formats.md)
107+
- [Test Annotations](tools/test-annotations.md)
108+
- [Running Tests](tools/running-tests.md)
109+
- [Diff](tools/diff.md)
110+
- [External SQL](tools/external-sql.md)
111+
- [SQL CONNECT](tools/sql-connect.md)
112+
- [Querying External Databases](tools/sql-query.md)
113+
- [IMPORT FROM](tools/import-from.md)
114+
- [Credential Management](tools/credentials.md)
115+
- [Database Connector Generation](tools/connector-generation.md)
116+
- [Docker Integration](tools/docker.md)
117+
- [mxcli docker build](tools/docker-build.md)
118+
- [mxcli docker run](tools/docker-run.md)
119+
- [OQL Queries](tools/oql.md)
120+
- [Dev Container Setup](tools/devcontainer.md)
121+
122+
---
123+
124+
# Part IV: IDE Integration
125+
126+
- [VS Code Extension](ide/vscode.md)
127+
- [Installation](ide/vscode-installation.md)
128+
- [Syntax Highlighting and Diagnostics](ide/vscode-syntax.md)
129+
- [Completion, Hover, Go-to-Definition](ide/vscode-intellisense.md)
130+
- [Project Tree](ide/vscode-project-tree.md)
131+
- [Context Menu Commands](ide/vscode-commands.md)
132+
- [LSP Server](ide/lsp.md)
133+
- [Protocol](ide/lsp-protocol.md)
134+
- [Capabilities](ide/lsp-capabilities.md)
135+
- [Integration with Other Editors](ide/lsp-editors.md)
136+
- [mxcli init](ide/mxcli-init.md)
137+
- [What Gets Created](ide/init-output.md)
138+
- [Customizing Skills](ide/customizing-skills.md)
139+
- [Syncing with Updates](ide/syncing.md)
140+
141+
---
142+
143+
# Part V: Go Library
144+
145+
- [Quick Start](library/quickstart.md)
146+
- [Installation](library/installation.md)
147+
- [Reading a Project](library/reading.md)
148+
- [Modifying a Project](library/modifying.md)
149+
- [Public API](library/public-api.md)
150+
- [Open / OpenForWriting](library/open.md)
151+
- [Reader Methods](library/reader-methods.md)
152+
- [Writer Methods](library/writer-methods.md)
153+
- [Fluent API](library/fluent-api.md)
154+
- [ModelAPI Entry Point](library/model-api.md)
155+
- [Builders](library/builders.md)
156+
- [Examples](library/fluent-examples.md)
157+
158+
---
159+
160+
# Part VI: MDL Statement Reference
161+
162+
- [Connection Statements](reference/connection/README.md)
163+
- [OPEN PROJECT](reference/connection/open-project.md)
164+
- [CLOSE PROJECT](reference/connection/close-project.md)
165+
- [Query Statements](reference/query/README.md)
166+
- [SHOW MODULES](reference/query/show-modules.md)
167+
- [SHOW ENTITIES](reference/query/show-entities.md)
168+
- [SHOW MICROFLOWS / NANOFLOWS](reference/query/show-microflows.md)
169+
- [SHOW PAGES / SNIPPETS](reference/query/show-pages.md)
170+
- [SHOW ENUMERATIONS](reference/query/show-enumerations.md)
171+
- [SHOW ASSOCIATIONS](reference/query/show-associations.md)
172+
- [SHOW CONSTANTS](reference/query/show-constants.md)
173+
- [SHOW WORKFLOWS](reference/query/show-workflows.md)
174+
- [SHOW BUSINESS EVENTS](reference/query/show-business-events.md)
175+
- [SHOW STRUCTURE](reference/query/show-structure.md)
176+
- [SHOW WIDGETS](reference/query/show-widgets.md)
177+
- [DESCRIBE ENTITY](reference/query/describe-entity.md)
178+
- [DESCRIBE MICROFLOW / NANOFLOW](reference/query/describe-microflow.md)
179+
- [DESCRIBE PAGE / SNIPPET](reference/query/describe-page.md)
180+
- [DESCRIBE ENUMERATION](reference/query/describe-enumeration.md)
181+
- [DESCRIBE ASSOCIATION](reference/query/describe-association.md)
182+
- [SEARCH](reference/query/search.md)
183+
- [Domain Model Statements](reference/domain-model/README.md)
184+
- [CREATE ENTITY](reference/domain-model/create-entity.md)
185+
- [ALTER ENTITY](reference/domain-model/alter-entity.md)
186+
- [DROP ENTITY](reference/domain-model/drop-entity.md)
187+
- [CREATE ENUMERATION](reference/domain-model/create-enumeration.md)
188+
- [DROP ENUMERATION](reference/domain-model/drop-enumeration.md)
189+
- [CREATE ASSOCIATION](reference/domain-model/create-association.md)
190+
- [DROP ASSOCIATION](reference/domain-model/drop-association.md)
191+
- [CREATE CONSTANT](reference/domain-model/create-constant.md)
192+
- [Microflow Statements](reference/microflow/README.md)
193+
- [CREATE MICROFLOW](reference/microflow/create-microflow.md)
194+
- [CREATE NANOFLOW](reference/microflow/create-nanoflow.md)
195+
- [DROP MICROFLOW / NANOFLOW](reference/microflow/drop-microflow.md)
196+
- [CREATE JAVA ACTION](reference/microflow/create-java-action.md)
197+
- [Page Statements](reference/page/README.md)
198+
- [CREATE PAGE](reference/page/create-page.md)
199+
- [CREATE SNIPPET](reference/page/create-snippet.md)
200+
- [ALTER PAGE / ALTER SNIPPET](reference/page/alter-page.md)
201+
- [DROP PAGE / SNIPPET](reference/page/drop-page.md)
202+
- [CREATE LAYOUT](reference/page/create-layout.md)
203+
- [Security Statements](reference/security/README.md)
204+
- [CREATE MODULE ROLE](reference/security/create-module-role.md)
205+
- [CREATE USER ROLE](reference/security/create-user-role.md)
206+
- [GRANT](reference/security/grant.md)
207+
- [REVOKE](reference/security/revoke.md)
208+
- [CREATE DEMO USER](reference/security/create-demo-user.md)
209+
- [Navigation Statements](reference/navigation/README.md)
210+
- [ALTER NAVIGATION](reference/navigation/alter-navigation.md)
211+
- [SHOW NAVIGATION](reference/navigation/show-navigation.md)
212+
- [Workflow Statements](reference/workflow/README.md)
213+
- [CREATE WORKFLOW](reference/workflow/create-workflow.md)
214+
- [DROP WORKFLOW](reference/workflow/drop-workflow.md)
215+
- [Business Event Statements](reference/business-event/README.md)
216+
- [CREATE BUSINESS EVENT SERVICE](reference/business-event/create-business-event-service.md)
217+
- [DROP BUSINESS EVENT SERVICE](reference/business-event/drop-business-event-service.md)
218+
- [Catalog Statements](reference/catalog/README.md)
219+
- [REFRESH CATALOG](reference/catalog/refresh-catalog.md)
220+
- [SELECT FROM CATALOG](reference/catalog/select-from-catalog.md)
221+
- [SHOW CALLERS / CALLEES](reference/catalog/show-callers-callees.md)
222+
- [SHOW REFERENCES / IMPACT / CONTEXT](reference/catalog/show-references-impact.md)
223+
- [SHOW CATALOG TABLES](reference/catalog/show-catalog-tables.md)
224+
- [External SQL Statements](reference/external-sql/README.md)
225+
- [SQL CONNECT](reference/external-sql/sql-connect.md)
226+
- [SQL DISCONNECT](reference/external-sql/sql-disconnect.md)
227+
- [SQL (query)](reference/external-sql/sql-query.md)
228+
- [SQL GENERATE CONNECTOR](reference/external-sql/sql-generate-connector.md)
229+
- [IMPORT FROM](reference/external-sql/import-from.md)
230+
- [Settings Statements](reference/settings/README.md)
231+
- [SHOW SETTINGS](reference/settings/show-settings.md)
232+
- [ALTER SETTINGS](reference/settings/alter-settings.md)
233+
- [Organization Statements](reference/organization/README.md)
234+
- [CREATE MODULE](reference/organization/create-module.md)
235+
- [CREATE FOLDER](reference/organization/create-folder.md)
236+
- [MOVE](reference/organization/move.md)
237+
- [Session Statements](reference/session/README.md)
238+
- [SET](reference/session/set.md)
239+
- [SHOW STATUS](reference/session/show-status.md)
240+
241+
---
242+
243+
# Part VII: Architecture & Internals
244+
245+
- [System Architecture](internals/architecture.md)
246+
- [Layer Diagram](internals/layers.md)
247+
- [Package Structure](internals/packages.md)
248+
- [Design Decisions](internals/design-decisions.md)
249+
- [MPR File Format](internals/mpr-format.md)
250+
- [v1 vs v2](internals/mpr-v1-v2.md)
251+
- [BSON Document Structure](internals/bson-structure.md)
252+
- [Storage Names vs Qualified Names](internals/storage-names.md)
253+
- [Widget Template System](internals/widget-templates.md)
254+
- [MDL Parser](internals/parser.md)
255+
- [ANTLR4 Grammar Design](internals/antlr4-grammar.md)
256+
- [Lexer - Parser - AST - Executor Pipeline](internals/parser-pipeline.md)
257+
- [Adding New Statements](internals/adding-statements.md)
258+
- [Catalog System](internals/catalog.md)
259+
- [SQLite Schema](internals/catalog-schema.md)
260+
- [FTS5 Full-Text Search](internals/fts5.md)
261+
- [Reference Tracking](internals/reference-tracking.md)
262+
263+
---
264+
265+
# Part VIII: Appendixes
266+
267+
- [MDL Quick Reference](appendixes/quick-reference.md)
268+
- [Data Type Mapping Table](appendixes/data-type-mapping.md)
269+
- [Reserved Words](appendixes/reserved-words.md)
270+
- [Mendix Version Compatibility](appendixes/version-compatibility.md)
271+
- [Common Mistakes and Anti-Patterns](appendixes/common-mistakes.md)
272+
- [Error Messages Reference](appendixes/error-messages.md)
273+
- [Glossary](appendixes/glossary.md)
274+
- [TypeScript SDK Equivalence](appendixes/sdk-equivalence.md)
275+
- [Changelog](appendixes/changelog.md)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+
Version history and release notes for ModelSDK Go and the mxcli tool.

0 commit comments

Comments
 (0)