@@ -13,6 +13,69 @@ All changes pushed to origin/main.
1313
1414## Work Completed (Recent)
1515
16+ ### 2026-01-28: Documentation Editorial Review (Continued)
17+
18+ Comprehensive editorial review of all documentation sections:
19+
20+ - [x] ** Concepts Section** (all files reviewed and fixed)
21+ - adaptor.md: Added missing "from", fixed link spacing
22+ - application.md: Complete rewrite - clarified applications are contexts with groups
23+ - case.md: Fixed "too"→"to" typo
24+ - connector.md: Removed unimplemented Subscriptions section
25+ - constant.md: Simplified to reference vital.md
26+ - definition.md: Removed outdated Hugo reference
27+ - description.md: Removed Hugo formatter reference
28+ - element.md: Fixed "Occurs In" and self-reference issues
29+ - entity.md: Fixed actor→user model, Eric Brewer, event-sourced hyphenation
30+ - epic.md: Fixed "an user"→"a user" (3 instances)
31+ - function.md: Fixed wrong handler link
32+ - group.md: Fixed broken Hugo icon shortcode
33+ - handler.md: Fixed Projection→Projector
34+ - interaction.md: Fixed "an Use Case"→"a Use Case"
35+ - message.md: Removed duplicate application line, fixed principal→principle,
36+ Projections→Projectors
37+ - onclause.md: Fixed receipient→recipient, whenthe→when the
38+ - option.md: Fixed link spacing, added missing period
39+ - output.md: Fixed "an user"→"a user"
40+ - processor.md: Complete rewrite explaining abstract concept and concrete types
41+ - projector.md: Fixed projections→projectors
42+ - repository.md: Fixed wrong anchor links (#query→#command, #result→#event)
43+ - sagastep.md: Fixed examples→clauses
44+ - type.md: Fixed Hugo TOC shortcode, RIDDL syntax (any of/one of)
45+ - user.md: Changed Actor→User per Use Cases 2.0 terminology
46+ - vital.md: Fixed truncation, removed Applications, added Streamlets
47+
48+ - [x] ** Guides Section** (all files reviewed and fixed)
49+ - authors/index.md: Fixed event-sourced hyphenation, updated doc generation
50+ to reference Synapify
51+ - developers/index.md: Updated JDK 21→25, Scala 3.6.x→3.3.x LTS, noted hugo
52+ migration to Synapify, fixed sbt stage→sbt riddlc/stage
53+ - domain-experts/duties.md: Fixed "context or"→"context of"
54+ - domain-experts/index.md: Replaced Hugo toc-tree shortcode
55+ - domain-experts/relating-to-riddl.md: Fixed Riddl→RIDDL in title
56+ - implementors/index.md: Replaced Hugo toc-tree shortcode
57+ - implementors/ways-to-use-riddl.md: Fixed sbt stage commands, updated HOCON
58+ example for validate-only, removed hugo references, added Synapify links
59+
60+ - [x] ** Tools Section** (all files reviewed and fixed)
61+ - index.md: Updated riddlc description to validation-only, added Synapify link
62+ - riddlc/index.md: Fixed sbt stage, removed hugo command sections, updated
63+ HOCON config to use common section, added Synapify links
64+ - riddl-idea-plugin/index.md: Updated JDK 21→25
65+ - riddl-mcp-server/index.md: Clean, no issues
66+
67+ - [x] ** OSS Section** (all files reviewed and fixed)
68+ - authoring-riddl.md: Fixed "one of"→"any of" for enumerations (2 instances)
69+ - intellij-plugin/index.md: Updated JDK 21→25
70+ - vscode-extension/index.md: Clean, no issues
71+ - index.md: Clean, no issues
72+
73+ - [x] ** MCP Section** (all files reviewed)
74+ - All files clean, no issues found
75+
76+ - [x] ** References Section** (reviewed)
77+ - index.md: Clean, no issues
78+
1679### 2026-01-27: Documentation Editorial Review
1780
1881Grammar, style, spelling, and accuracy review of documentation:
@@ -34,15 +97,6 @@ Grammar, style, spelling, and accuracy review of documentation:
3497 - Added Hugo remnant removal guidance
3598 - Documented RIDDL syntax validation rules for examples
3699
37- - [ ] ** Concepts Section** (in progress, 3 files uncommitted)
38- - Fixed Hugo shortcode in index.md
39- - Fixed icon syntax and grammar in domain.md
40- - Fixed apostrophe and punctuation in context.md
41-
42- ** Pending for next session:**
43- - entity.md: "user model" → "actor model", "Erik" → "Eric" Brewer, typos
44- - Continue through remaining ~ 85 concept and other files
45-
46100### 2026-01-26: Synapify User Guide Expansion
47101
48102Comprehensive expansion of Synapify documentation based on product discussion:
@@ -160,12 +214,7 @@ Completed all 6 phases of the comprehensive documentation improvement:
160214
161215## In Progress
162216
163- ### Documentation Editorial Review
164- - Reviewing all docs/ markdown files for grammar, style, accuracy
165- - Validating RIDDL syntax examples against EBNF grammar
166- - Removing outdated technology references
167- - Ensuring consistent tone (light, accessible, technically precise)
168- - ** Next** : Continue with concepts section (entity.md and beyond)
217+ Editorial review complete. All sections reviewed and fixed. Ready to commit.
169218
170219## Pending Tasks
171220
@@ -180,9 +229,69 @@ Completed all 6 phases of the comprehensive documentation improvement:
180229
181230| Task | File | Notes |
182231| ------| ------| -------|
232+ | RIDDL Pygments lexer | New file | Custom syntax highlighting for code blocks |
183233| Type examples | ` references/language-reference.md ` | Add specialized examples |
184234| Future work review | ` future-work/ ` | Update for current roadmap |
185235| Quick-start tutorial | New file | Optional getting started guide |
236+ | EBNF grammar validation | ` references/ebnf-grammar.md ` | See details below |
237+
238+ #### Synapify Generation Configuration Documentation
239+
240+ When documenting Synapify's documentation/code generation features, use this
241+ HOCON configuration example as a starting point (preserved from riddlc hugo):
242+
243+ ``` hocon
244+ hugo {
245+ input-file = "ReactiveBBQ.riddl"
246+ output-dir = "target/hugo/ReactiveBBQ"
247+ project-name = "Reactive BBQ"
248+ site-title = "Reactive BBQ Generated Specification"
249+ site-description = "Generated specification for the Reactive BBQ application"
250+ site-logo-path = "images/RBBQ.png"
251+ erase-output = true
252+ base-url = "https://bbq.riddl.tech"
253+ source-url = "https://github.com/ossuminc/riddl"
254+ edit-path = "/-/blob/main/src/riddl/ReactiveBBQ"
255+ }
256+ ```
257+
258+ #### RIDDL Pygments Lexer Task
259+
260+ Create a custom Pygments lexer for RIDDL syntax highlighting in MkDocs code
261+ blocks. Currently ` riddl ` fenced code blocks render without syntax coloring.
262+
263+ ** Implementation approach:**
264+ 1 . Create ` riddl_lexer.py ` with a ` RiddlLexer ` class extending ` RegexLexer `
265+ 2 . Define token patterns for RIDDL keywords, types, strings, comments, etc.
266+ 3 . Register the lexer in ` mkdocs.yml ` or via a plugin
267+ 4 . Test with existing code examples in documentation
268+
269+ ** Key token categories:**
270+ - Keywords: ` domain ` , ` context ` , ` entity ` , ` handler ` , ` type ` , ` command ` ,
271+ ` event ` , ` query ` , ` result ` , ` is ` , ` of ` , ` to ` , ` from ` , ` inlet ` , ` outlet ` , etc.
272+ - Predefined types: ` String ` , ` Number ` , ` Boolean ` , ` Date ` , ` Time ` , ` UUID ` , etc.
273+ - Operators: ` = ` , ` : ` , ` { ` , ` } ` , ` ( ` , ` ) ` , ` [ ` , ` ] `
274+ - Comments: ` // ` line comments, ` /* */ ` block comments
275+ - Strings: quoted literals
276+
277+ #### EBNF Grammar Validation Task
278+
279+ The EBNF grammar (` docs/riddl/references/ebnf-grammar.md ` ) is derived from the
280+ official fastparse grammar in the riddl module and is intended for AI tools to
281+ quickly understand RIDDL syntax. It must accurately reflect the rules accepted
282+ by the fastparse parser.
283+
284+ ** Known discrepancies found during editorial review:**
285+ - Missing ` = ` as alternative to ` is ` in type definitions
286+ - Missing ` : ` as alternative to ` is ` in field definitions (Scala-style syntax)
287+
288+ ** Validation approach:**
289+ 1 . Create a functional parser from the EBNF grammar
290+ 2 . Run it against all example RIDDL sources in the test suite
291+ 3 . Compare results with the fastparse parser
292+ 4 . Revise EBNF until there are no discrepancies
293+
294+ This ensures the EBNF remains a reliable reference for AI-assisted RIDDL work.
186295
187296## Design Decisions Log
188297
0 commit comments