Skip to content

Commit 935598a

Browse files
respencer-nclclaude
andcommitted
Reorganize Future Work into Coming Soon section
- Create consolidated Coming Soon page with Simulation and Generation sections - Move future-work content to top-level nav (before About) - Include generation targets from riddl-gen roadmap - Fix broken fontawesome icons with material-recycle icon - Remove old docs/riddl/future-work/ directory Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 562f0e4 commit 935598a

15 files changed

Lines changed: 111 additions & 205 deletions

File tree

NOTEBOOK.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@
55
Documentation site is complete and deployed at https://ossum.tech. All major
66
sections are documented with proper RIDDL syntax highlighting.
77

8+
**Completed (2026-01-29):**
9+
10+
- Reorganized "Future Work" into top-level "Coming Soon" section
11+
- Created consolidated `docs/coming-soon/index.md` with Simulation and
12+
Generation sections
13+
- Removed old `docs/riddl/future-work/` directory (8 files)
14+
- Generation section includes targets from riddl-gen NOTEBOOK.md
15+
- Fixed broken fontawesome icons (`:fontawesome-regular-rotate-left:`) with
16+
Material Design icons (`:material-recycle:`) in concept pages
17+
- Migrated RIDDL documentation from riddl.tech (Hugo) to ossum.tech (MkDocs)
18+
- Created migration script: `scripts/migrate-hugo.py`
19+
- Added Tutorials section with complete RBBQ case study (18 files)
20+
- Expanded Tools/riddlc with installation, commands, configuration, etc.
21+
- Added sbt-riddl plugin documentation
22+
- Added Design Guide (contexts, command-event patterns, UI modeling)
23+
- Added Developer Guide (principles, releasing)
24+
- Updated mkdocs.yml navigation for all new sections
25+
- Verified build with `mkdocs build --strict`
26+
827
**Completed (2026-01-28):**
928

1029
- Navigation reordered: RIDDL → Synapify → MCP → IDE Support → About
@@ -60,7 +79,6 @@ sections are documented with proper RIDDL syntax highlighting.
6079
| Task | File | Notes |
6180
|------|------|-------|
6281
| Type examples | `references/language-reference.md` | Add specialized examples |
63-
| Future work review | `future-work/` | Update for current roadmap |
6482
| Synapify generation docs | `synapify/generation.md` | Use preserved config |
6583

6684
---

docs/coming-soon/index.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "Coming Soon"
3+
description: "Upcoming features for the RIDDL ecosystem"
4+
---
5+
6+
# Coming Soon
7+
8+
This page outlines upcoming capabilities for the RIDDL ecosystem. These
9+
features are under active development and will be available through
10+
[Synapify](../synapify/index.md) and related tooling.
11+
12+
---
13+
14+
## Simulation
15+
16+
The [riddlsim](https://github.com/ossuminc/riddlsim) engine executes RIDDL
17+
models against test scenarios, validating behavior before implementation.
18+
19+
**Why simulate?**
20+
21+
- **Catch design errors early** before they become expensive implementation
22+
bugs
23+
- **Verify state transitions** to ensure entities move through expected
24+
lifecycles
25+
- **Test edge cases** that might be overlooked in manual review
26+
- **Build stakeholder confidence** by demonstrating working behavior early
27+
- **Document expected behavior** through executable scenarios
28+
29+
Simulation scenarios define inputs, expected events, and state assertions.
30+
When a scenario runs, the simulator parses your model, executes the
31+
scenario steps, and reports whether outcomes match expectations.
32+
33+
For detailed information on simulation capabilities and integration with
34+
Synapify, see the [Synapify Simulation Guide](../synapify/simulation.md).
35+
36+
---
37+
38+
## Generation
39+
40+
The RIDDL ecosystem will support code and artifact generation from validated
41+
models. Generation transforms your domain model into runnable infrastructure,
42+
documentation, and integration artifacts.
43+
44+
### Documentation Generators
45+
46+
| Target | Description |
47+
|--------|-------------|
48+
| **Hugo** | Static documentation site with navigation, diagrams, and cross-references. Currently available. |
49+
| **AsciiDoc** | Technical documentation in AsciiDoc format for integration with enterprise documentation systems. |
50+
| **Diagrams** | Mermaid-based visualizations including context maps, data flow, sequence diagrams, and entity relationships. |
51+
52+
### API & Schema Generators
53+
54+
| Target | Description |
55+
|-------------|-------------------------------------------------------------------------------------------------------------|
56+
| **OpenAPI** | OpenAPI (Swagger) specifications documenting REST APIs implied by Applications and their endpoints. |
57+
| **gRPC** | Google's efficient serialization format protobuf enables gRPC services and cross-language interoperability. |
58+
| **Smithy** | AWS Interface Definition Language for defining services that integrate with AWS infrastructure. |
59+
60+
### Runtime Code Generators
61+
62+
| Target | Description |
63+
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
64+
| **Akka** | Complete Scala/Akka project including actors, protobuffers, sbt build files, and runtime dependencies. Generates infrastructure code while leaving business logic to developers or have AI do the whole job. |
65+
| **Quarkus** | Complete Java/Quarkus project using many Quarkus ecosystem features for reactive distributed systems. |
66+
67+
### Integration Generators
68+
69+
| Target | Description |
70+
|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
71+
| **Backstage** | Catalog entries for [Spotify Backstage](https://backstage.io/) developer portals, documenting service ownership and relationships. |
72+
| **BAST** | Binary Abstract Syntax Tree format for faster parsing. Saves validated models in a binary format that loads quickly, avoiding re-parsing and re-validation. |
73+
74+
### Extending Generation
75+
76+
The generation architecture is designed for extensibility. Custom generators can
77+
be implemented to target additional platforms, frameworks, or output formats.
78+
If you need a specific kind of generation, email us at mailto:support@ossuminc.com
79+
80+
---
81+
82+
!!! NOTE: Timeline
83+
84+
These features are being developed iteratively. Generators will be released
85+
as they reach production quality. For the latest status, see the
86+
[Synapify documentation](../synapify/index.md).

docs/riddl/concepts/domain.md

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

3737
* [Root](root.md)
38-
* [Domains](domain.md) :fontawesome-regular-rotate-left: — domains
38+
* [Domains](domain.md) :material-recycle: — domains
3939
can be nested in a super-domain
4040

4141
## Contains
@@ -46,7 +46,7 @@ Within a domain, you can define these things:
4646
* [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
49-
* [Domains](domain.md) :fontawesome-regular-rotate-left: - domains
49+
* [Domains](domain.md) :material-recycle: - domains
5050
can have nested domains (subdomains)
5151
* [Epics](epic.md) - a story about external entities
5252
interacting with the domain

docs/riddl/concepts/element.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ different group of elements, enabling navigation within the application.
4646
* [Group](group.md)
4747

4848
## Contains
49-
* [Group](group.md) :fontawesome-regular-rotate-left:
49+
* [Group](group.md) :material-recycle:
5050
* [Handlers](handler.md)
5151

docs/riddl/concepts/function.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ for something once.
1616
## Contains
1717
* [Fields](field.md)
1818
* [Statements](statement.md)
19-
* [Functions](function.md) :fontawesome-regular-rotate-left:
19+
* [Functions](function.md) :material-recycle:

docs/riddl/concepts/group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ their overall UI design theme.
2323
* [Group](group.md)
2424

2525
## Contains
26-
* [Group](group.md) :fontawesome-regular-rotate-left:
26+
* [Group](group.md) :material-recycle:
2727
* [Type](type.md)
2828
* [Input](input.md)
2929
* [Output](output.md)

docs/riddl/future-work/akka.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/riddl/future-work/analyses.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/riddl/future-work/bast.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/riddl/future-work/diagrams.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)