Skip to content

Commit bf16d12

Browse files
respencer-nclclaude
andcommitted
Continue editorial review: concepts section and session docs
Concepts section fixes: - Remove Hugo shortcode from index.md ({{< toc-tree >}}) - Fix icon syntax in domain.md (Hugo → Font Awesome) - Fix "an user" → "a user" grammar - Fix missing apostrophe and punctuation in context.md Session documentation: - CLAUDE.md: Add Editorial Guidelines section with learnings - NOTEBOOK.md: Update with 2026-01-27 session progress Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c2f1cc2 commit bf16d12

5 files changed

Lines changed: 130 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,4 +241,88 @@ Refer to the parent `../CLAUDE.md` for cross-project coordination guidance.
241241
| Start dev server | `mkdocs serve` |
242242
| Build site | `mkdocs build` |
243243
| Check links | `mkdocs build --strict` |
244-
| Deploy | `mkdocs gh-deploy` |
244+
| Deploy | `mkdocs gh-deploy` |
245+
246+
---
247+
248+
## Editorial Guidelines (Session Learnings)
249+
250+
These guidelines were established during documentation review sessions:
251+
252+
### Tooling Separation
253+
254+
**Important**: The RIDDL ecosystem has a clear separation of concerns:
255+
256+
- **`riddlc`** (open source): Syntax and semantic validation only. It reads
257+
RIDDL files, checks them, and reports errors. No code generation.
258+
- **Synapify** (commercial): Provides advanced features including code
259+
generation, documentation generation, and AI-assisted development. These
260+
features are available via subscription.
261+
262+
When documenting capabilities, do NOT claim that `riddlc` generates code,
263+
diagrams, Kubernetes manifests, etc. Those capabilities exist in Synapify.
264+
Avoid mentioning "riddl-gen" directly—it's an internal service name. Just
265+
refer to Synapify's generation features.
266+
267+
### Outdated Technology References
268+
269+
Remove or generalize references to specific generation targets that are no
270+
longer accurate:
271+
272+
- ~~Kalix~~ (no longer a target)
273+
- ~~Kubernetes deployment descriptors~~ (not in OSS tooling)
274+
- ~~Akka code generation~~ (not in OSS tooling)
275+
- ~~Protocol Buffers / Smithy / OpenAPI generation~~ (not in OSS tooling)
276+
277+
Instead, describe RIDDL's *capability* to enable such translation without
278+
claiming specific tool support.
279+
280+
### Hugo Remnants
281+
282+
This site migrated from Hugo to MkDocs Material. Remove any Hugo shortcodes:
283+
284+
- `{{< toc-tree >}}` — doesn't work in MkDocs
285+
- `{{< icon "..." >}}` — use Font Awesome syntax or remove
286+
- Any other `{{< ... >}}` patterns
287+
288+
### Capitalization
289+
290+
Always use **RIDDL** (all caps) in prose. It's an acronym. Not "Riddl" or
291+
"riddl" except in code/filenames where lowercase is conventional.
292+
293+
### RIDDL Syntax in Examples
294+
295+
Code examples must match the EBNF grammar. Common issues to avoid:
296+
297+
1. **Missing `is` keyword**: Most definitions require it.
298+
- Wrong: `on command Foo { ... }`
299+
- Right: `on command Foo is { ... }`
300+
301+
2. **User stories require both parts**:
302+
- Right: `user Customer wants to "do X" so that "Y happens"`
303+
304+
3. **Epics and use cases start with user stories**:
305+
```riddl
306+
epic Shopping is {
307+
user Customer wants to "..." so that "..."
308+
case AddToCart is { ... }
309+
}
310+
```
311+
312+
4. **Step interactions use specific syntax**:
313+
- `step for user Customer is "does something"`
314+
- `step send command X from user Y to entity Z`
315+
- `step show output X to user Y`
316+
317+
### Tone and Style
318+
319+
- Light, accessible, occasionally jovial
320+
- Technical precision without being dry
321+
- Explain concepts before showing syntax
322+
- Use em-dashes for asides—they read more naturally
323+
- Prefer active voice
324+
325+
### Known Authors (Correct Spellings)
326+
327+
For the Reactive Manifesto: Jonas Bonér, **Dave** Farley (not David),
328+
Roland **Kuhn** (not Kunh), Martin Thompson.

NOTEBOOK.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,36 @@ All changes pushed to origin/main.
1313

1414
## Work Completed (Recent)
1515

16+
### 2026-01-27: Documentation Editorial Review
17+
18+
Grammar, style, spelling, and accuracy review of documentation:
19+
20+
- [x] **Introduction Section** (9 files, committed)
21+
- Fixed duplicate navigation list in index.md
22+
- Standardized RIDDL capitalization throughout
23+
- Updated what-can-riddl-do.md to reflect riddlc as validator only
24+
- Fixed invalid RIDDL syntax in code examples (why-is-riddl-needed.md)
25+
- Removed outdated technology references (Kalix, Kubernetes, etc.)
26+
- Fixed typos: Branchs→Branches, Kuberenetes→Kubernetes, Roland Kunh→Kuhn
27+
- Fixed broken anchor syntax and URLs
28+
- Fixed missing words and broken markdown links
29+
30+
- [x] **CLAUDE.md Updates**
31+
- Added Editorial Guidelines section with session learnings
32+
- Documented tooling separation (riddlc vs Synapify)
33+
- Added guidance on outdated technology references
34+
- Added Hugo remnant removal guidance
35+
- Documented RIDDL syntax validation rules for examples
36+
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+
1646
### 2026-01-26: Synapify User Guide Expansion
1747

1848
Comprehensive expansion of Synapify documentation based on product discussion:
@@ -130,7 +160,12 @@ Completed all 6 phases of the comprehensive documentation improvement:
130160

131161
## In Progress
132162

133-
None currently.
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)
134169

135170
## Pending Tasks
136171

docs/riddl/concepts/context.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ on the same page.
5151

5252
When modelling a system with RIDDL, the *ubiquitous language* boils down to
5353
the names of the definitions that RIDDL permits inside a `context` definition, as
54-
shown in the list below. You can correctly think of a `context`s ubiquitous
54+
shown in the list below. You can correctly think of a `context`'s ubiquitous
5555
language as the interface to that knowledge domain. It is very analogous to
5656
an API (Application Programming Interface) as the interface to a program. The API
5757
defines the contract for how external systems interact with the bounded context.
5858

59-
To further your understanding, watch this
59+
To further your understanding, watch this
6060
[34-minute video](https://www.youtube.com/watch?v=am-HXycfalo) by
61-
[Eric Evans](../introduction/who-made-riddl-possible.md#eric-evans)
62-
from DDD Europe 2020 conference
61+
[Eric Evans](../introduction/who-made-riddl-possible.md#eric-evans)
62+
from DDD Europe 2020 conference.
6363

6464

6565
## Occurs In

docs/riddl/concepts/domain.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ might devise a domain hierarchy like this:
3535
## Occurs In
3636

3737
* [Root](root.md)
38-
* [Domains](domain.md) {{< icon "rotate-left - domains
39-
can be nested in a super-domain.
38+
* [Domains](domain.md) :fontawesome-regular-rotate-left: — domains
39+
can be nested in a super-domain
4040

4141
## Contains
4242

4343
Within a domain, you can define these things:
4444

4545
* [Actors](user.md) - someone or thing that uses the domain
46-
* [Applications](application.md) - an user interface
46+
* [Applications](application.md) - a user interface
4747
* [Authors](author.md) - who defined the domain
4848
* [Contexts](context.md) - a precisely defined bounded context within the domain
4949
* [Domains](domain.md) :fontawesome-regular-rotate-left: - domains

docs/riddl/concepts/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,5 @@ When you're done exploring all the concepts, check out our
105105

106106
## Full Index
107107

108-
{{< toc-tree >}}
108+
The pages in this section cover each RIDDL concept in detail. Use the
109+
navigation menu to explore individual concepts.

0 commit comments

Comments
 (0)