|
2 | 2 |
|
3 | 3 | ## Current Status |
4 | 4 |
|
5 | | -The ossum.tech documentation site has undergone a comprehensive 6-phase |
6 | | -improvement. All major sections are now complete with accurate, well-organized |
7 | | -content. The site is ready for review and deployment. |
| 5 | +Open source release documentation is now complete. The site includes: |
8 | 6 |
|
9 | | -**7 commits pending push to origin/main.** |
| 7 | +- **OSS Section**: IntelliJ plugin and VS Code extension documentation |
| 8 | +- **MCP Section**: RIDDL MCP Server with installation guides for 5 AI tools |
| 9 | +- **Authoring Guide**: Common RIDDL writing best practices |
| 10 | + |
| 11 | +Ready for review and testing with `mkdocs serve`. |
10 | 12 |
|
11 | 13 | ## Work Completed (Recent) |
12 | 14 |
|
| 15 | +### 2026-01-21: Open Source Release Documentation |
| 16 | + |
| 17 | +Created comprehensive documentation for open source product releases: |
| 18 | + |
| 19 | +- [x] **Authoring RIDDL Sources** (`docs/OSS/authoring-riddl.md`) |
| 20 | + - File organization and includes |
| 21 | + - Metadata with `with` clause (authors, terms, descriptions) |
| 22 | + - Type definitions and predefined types |
| 23 | + - Message types (commands, events, queries, results) |
| 24 | + - Entity design patterns |
| 25 | + - Handler statements reference |
| 26 | + - Common patterns (aggregates, sagas) |
| 27 | + |
| 28 | +- [x] **IntelliJ Plugin Documentation** (`docs/OSS/intellij-plugin/index.md`) |
| 29 | + - Complete feature documentation |
| 30 | + - Installation instructions (beta and marketplace) |
| 31 | + - Configuration options reference |
| 32 | + - Tool window usage guide |
| 33 | + - Troubleshooting section |
| 34 | + |
| 35 | +- [x] **VS Code Extension Documentation** (`docs/OSS/vscode-extension/index.md`) |
| 36 | + - All features documented (completion, diagnostics, navigation) |
| 37 | + - Keyboard shortcuts reference |
| 38 | + - Command palette commands |
| 39 | + - Configuration options |
| 40 | + - Troubleshooting section |
| 41 | + |
| 42 | +- [x] **MCP Section** (`docs/MCP/`) |
| 43 | + - Main overview page with capabilities |
| 44 | + - Claude Desktop configuration guide |
| 45 | + - Claude Code configuration guide |
| 46 | + - Gemini CLI configuration guide |
| 47 | + - VS Code Copilot configuration guide |
| 48 | + - IntelliJ AI Assistant configuration guide |
| 49 | + - IntelliJ Junie configuration guide |
| 50 | + - Server URL placeholder (`{{MCP_SERVER_URL}}`) |
| 51 | + - Authentication documentation |
| 52 | + |
| 53 | +- [x] **OSS Index Update** (`docs/OSS/index.md`) |
| 54 | + - Links to all IDE extensions |
| 55 | + - Links to authoring guide |
| 56 | + - Links to MCP section |
| 57 | + - Getting started workflow |
| 58 | + |
13 | 59 | ### 2026-01-21: Documentation Improvement Plan Execution |
14 | 60 |
|
15 | 61 | Completed all 6 phases of the comprehensive documentation improvement: |
16 | 62 |
|
17 | 63 | - [x] **Phase 1**: Fix critical documentation accuracy issues |
18 | | - - Updated `statement.md` with current statement types |
19 | | - - Fixed containment rules in language reference to match EBNF |
20 | | - - Corrected include directive syntax |
21 | | - |
22 | 64 | - [x] **Phase 2**: Add missing processor documentation |
23 | | - - Expanded Handlers section with all `on` clause types |
24 | | - - Added Adaptors, Projectors, Streamlets, Connectors to language reference |
25 | | - |
26 | 65 | - [x] **Phase 3**: Complete introduction section |
27 | | - - Rewrote `why-is-riddl-needed.md` (was TODO notes) |
28 | | - - Completed Jacobsen Use Cases 2.0 section |
29 | | - |
30 | 66 | - [x] **Phase 4**: Complete tools documentation |
31 | | - - Wrote comprehensive `riddlc/index.md` |
32 | | - - Wrote `riddl-idea-plugin/index.md` with features and troubleshooting |
33 | | - - Wrote `riddl-mcp-server/index.md` with setup, auth, API reference |
34 | | - |
35 | 67 | - [x] **Phase 5**: Complete guides |
36 | | - - Wrote full Developers Guide with architecture and contribution info |
37 | | - - Completed Domain Experts duties and relating-to-riddl guides |
38 | | - - Completed Implementors ways-to-use-riddl with SBT integration |
39 | | - |
40 | 68 | - [x] **Phase 6**: Fix concepts section issues |
41 | | - - Fixed broken links, heading levels, typos |
42 | | - - Completed metadata.md, conditional.md, streamlet.md, use-case.md |
43 | | - - Fixed incorrect "Occurs In" references |
44 | 69 |
|
45 | 70 | ### 2026-01-20: Initial Setup |
46 | 71 |
|
47 | 72 | - [x] Created CLAUDE.md for this repository |
48 | 73 | - [x] Created NOTEBOOK.md to track pending work |
49 | 74 | - [x] Audited all documentation for WIP markers |
50 | | -- [x] Completed Author's Guide (`docs/riddl/guides/authors/index.md`) |
51 | | -- [x] Improved hierarchy diagram in `docs/riddl/concepts/index.md` |
| 75 | +- [x] Completed Author's Guide |
| 76 | +- [x] Improved hierarchy diagram in concepts |
52 | 77 |
|
53 | 78 | ## In Progress |
54 | 79 |
|
55 | | -None currently. All planned phases complete. |
| 80 | +None currently. |
56 | 81 |
|
57 | 82 | ## Pending Tasks |
58 | 83 |
|
59 | | -### Lower Priority (Not in original plan) |
| 84 | +### Before Deployment |
| 85 | + |
| 86 | +| Task | Notes | |
| 87 | +|------|-------| |
| 88 | +| Run `mkdocs build --strict` | Verify all links work | |
| 89 | +| Replace `{{MCP_SERVER_URL}}` | When public URL is available | |
| 90 | +| Update release download links | When final releases are published | |
| 91 | + |
| 92 | +### Lower Priority |
60 | 93 |
|
61 | 94 | | Task | File | Notes | |
62 | 95 | |------|------|-------| |
63 | | -| Type examples | `references/language-reference.md` | Add more specialized type examples | |
64 | | -| Future work review | `future-work/` | May need updates for current roadmap | |
65 | | -| Verify link integrity | All files | Run `mkdocs build --strict` | |
| 96 | +| Type examples | `references/language-reference.md` | Add specialized examples | |
| 97 | +| Future work review | `future-work/` | Update for current roadmap | |
| 98 | +| Quick-start tutorial | New file | Optional getting started guide | |
66 | 99 |
|
67 | 100 | ## Design Decisions Log |
68 | 101 |
|
69 | 102 | | Decision | Rationale | Date | |
70 | 103 | |----------|-----------|------| |
| 104 | +| Separate MCP section | MCP is distinct from IDE plugins; deserves own nav section | 2026-01-21 | |
| 105 | +| Per-tool MCP guides | Each AI tool has unique config; separate pages clearer | 2026-01-21 | |
| 106 | +| Common authoring guide | Avoid duplication; same content for any IDE | 2026-01-21 | |
| 107 | +| URL placeholder | `{{MCP_SERVER_URL}}` allows easy find/replace later | 2026-01-21 | |
71 | 108 | | 6-phase approach | Systematic improvement with commits after each phase | 2026-01-21 | |
72 | | -| Statement rewrite | Old statement.md listed obsolete types from removed features | 2026-01-21 | |
73 | | -| Processor docs in lang-ref | Language reference is authoritative; concepts link to it | 2026-01-21 | |
74 | | -| Domain expert focus | Guides written for non-programmers working with AI | 2026-01-21 | |
| 109 | +| Statement rewrite | Old statement.md listed obsolete types | 2026-01-21 | |
| 110 | +| Processor docs in lang-ref | Language reference is authoritative | 2026-01-21 | |
75 | 111 |
|
76 | 112 | ## Next Steps |
77 | 113 |
|
78 | | -1. Push 7 commits to origin/main |
79 | | -2. Run `mkdocs build --strict` to verify all links |
80 | | -3. Deploy to production with `mkdocs gh-deploy` |
81 | | -4. Consider adding Quick Start tutorial (optional) |
82 | | - |
83 | | -## Files Modified in This Session |
84 | | - |
85 | | -### Introduction |
86 | | -- `docs/riddl/introduction/why-is-riddl-needed.md` (rewritten) |
87 | | -- `docs/riddl/introduction/what-is-riddl-based-on.md` (completed) |
88 | | -- `docs/riddl/introduction/what-conventions-does-riddl-use.md` (fixed) |
89 | | - |
90 | | -### Language Reference |
91 | | -- `docs/riddl/references/language-reference.md` (expanded significantly) |
92 | | - |
93 | | -### Tools |
94 | | -- `docs/riddl/tools/index.md` (fixed) |
95 | | -- `docs/riddl/tools/riddlc/index.md` (written) |
96 | | -- `docs/riddl/tools/riddl-idea-plugin/index.md` (written) |
97 | | -- `docs/riddl/tools/riddl-mcp-server/index.md` (written) |
98 | | - |
99 | | -### Guides |
100 | | -- `docs/riddl/guides/developers/index.md` (written) |
101 | | -- `docs/riddl/guides/domain-experts/duties.md` (completed) |
102 | | -- `docs/riddl/guides/domain-experts/relating-to-riddl.md` (completed) |
103 | | -- `docs/riddl/guides/implementors/ways-to-use-riddl.md` (completed) |
104 | | - |
105 | | -### Concepts |
106 | | -- `docs/riddl/concepts/statement.md` (rewritten) |
107 | | -- `docs/riddl/concepts/epic.md` (fixed) |
108 | | -- `docs/riddl/concepts/case.md` (fixed) |
109 | | -- `docs/riddl/concepts/field.md` (fixed) |
110 | | -- `docs/riddl/concepts/processor.md` (fixed) |
111 | | -- `docs/riddl/concepts/handler.md` (completed) |
112 | | -- `docs/riddl/concepts/context.md` (completed) |
113 | | -- `docs/riddl/concepts/outlet.md` (fixed) |
114 | | -- `docs/riddl/concepts/value.md` (completed) |
115 | | -- `docs/riddl/concepts/sagastep.md` (fixed) |
116 | | -- `docs/riddl/concepts/element.md` (completed) |
117 | | -- `docs/riddl/concepts/metadata.md` (written) |
118 | | -- `docs/riddl/concepts/conditional.md` (completed) |
119 | | -- `docs/riddl/concepts/streamlet.md` (written) |
120 | | -- `docs/riddl/concepts/use-case.md` (expanded) |
| 114 | +1. Review documentation with `mkdocs serve` |
| 115 | +2. Run `mkdocs build --strict` to verify links |
| 116 | +3. Push commits to origin/main |
| 117 | +4. Deploy to production with `mkdocs gh-deploy` |
| 118 | +5. Update `{{MCP_SERVER_URL}}` when public URL available |
| 119 | + |
| 120 | +## Files Created/Modified in This Session |
| 121 | + |
| 122 | +### OSS Documentation |
| 123 | +- `docs/OSS/index.md` (updated) |
| 124 | +- `docs/OSS/authoring-riddl.md` (new) |
| 125 | +- `docs/OSS/intellij-plugin/index.md` (rewritten) |
| 126 | +- `docs/OSS/vscode-extension/index.md` (rewritten) |
| 127 | + |
| 128 | +### MCP Documentation |
| 129 | +- `docs/MCP/index.md` (new) |
| 130 | +- `docs/MCP/claude-desktop.md` (new) |
| 131 | +- `docs/MCP/claude-code.md` (new) |
| 132 | +- `docs/MCP/gemini.md` (new) |
| 133 | +- `docs/MCP/vscode-copilot.md` (new) |
| 134 | +- `docs/MCP/intellij-ai.md` (new) |
| 135 | +- `docs/MCP/intellij-junie.md` (new) |
121 | 136 |
|
122 | 137 | ## Open Questions |
123 | 138 |
|
| 139 | +- What is the public URL for the RIDDL MCP Server? |
124 | 140 | - Should there be a quick-start tutorial separate from the guides? |
125 | | -- Are there additional processor types that need documentation? |
| 141 | +- Are there additional AI tools that need MCP configuration guides? |
0 commit comments