@@ -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.
0 commit comments