Skip to content

Commit a8c95ce

Browse files
respencer-nclclaude
andcommitted
Add strategic site improvements for conversion and discovery
Phase 1 implementation to improve visitor engagement: - 5-minute quickstart tutorial for new users - Example models gallery linking to riddl-models repo - Playground placeholder page for future interactive editor - SEO meta descriptions on key pages - Edit links for community contributions - PWA/offline support via service worker - Expanded About page with company story Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 538cc8f commit a8c95ce

14 files changed

Lines changed: 834 additions & 14 deletions

File tree

CLAUDE.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ ossum.tech/
1818
│ │ ├── introduction/ # What is RIDDL, why it exists
1919
│ │ ├── concepts/ # RIDDL language concepts (domain, context, etc.)
2020
│ │ ├── guides/ # User guides by role (authors, domain experts, etc.)
21+
│ │ ├── examples/ # Model gallery linking to riddl-models repo
22+
│ │ ├── playground/ # Interactive RIDDL editor (coming soon)
2123
│ │ ├── references/ # Language reference and EBNF grammar
2224
│ │ ├── tools/ # Documentation for riddlc, IDE plugins, etc.
2325
│ │ └── future-work/ # Planned features and roadmap
@@ -96,12 +98,15 @@ dark and light themes.
9698
### MkDocs Configuration
9799

98100
The site uses MkDocs Material theme with these notable features:
99-
- Automatic light/dark mode
101+
- Automatic light/dark mode with visible toggle
100102
- Navigation tabs
101103
- Search with highlighting
102104
- Admonitions (info boxes, warnings, etc.)
103105
- Code highlighting via Pygments with custom RIDDL lexer
104106
- Custom CSS in `docs/stylesheets/`
107+
- **Edit links** - Each page links to GitHub for community contributions
108+
- **PWA/offline support** - Service worker caches pages for offline access
109+
- **SEO meta descriptions** - Key pages have frontmatter descriptions
105110

106111
### Markdown Extensions
107112

@@ -286,6 +291,7 @@ This documentation site covers tools from other Ossum Inc. repositories:
286291
- **riddl-idea-plugin**: IntelliJ IDEA plugin for RIDDL
287292
- **riddl-vscode**: VS Code extension for RIDDL (source for lexer tokens)
288293
- **riddl-mcp-server**: MCP server for AI-assisted RIDDL modeling
294+
- **riddl-models**: Curated example models (linked from `docs/riddl/examples/`)
289295

290296
Refer to the parent `../CLAUDE.md` for cross-project coordination guidance.
291297

NOTEBOOK.md

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

8-
**Recent completion (2026-01-28):**
9-
- RIDDL Pygments lexer with custom color scheme matching IDE tools
10-
- Comprehensive editorial review of all documentation sections
11-
- CI workflow updated to install lexer before building
8+
**Completed (2026-01-28):**
9+
10+
- Strategic site improvements Phase 1 (quickstart, examples gallery, SEO,
11+
edit links, PWA support, about page, playground placeholder)
12+
- RIDDL Pygments lexer with custom color scheme
13+
- Comprehensive editorial review
14+
- CI workflow with lexer installation
1215

1316
---
1417

@@ -20,13 +23,35 @@ sections are documented with proper RIDDL syntax highlighting.
2023
|------|-------|
2124
| Replace `{{MCP_SERVER_URL}}` | When public URL is available |
2225
| Update release download links | When final releases are published |
26+
| Implement playground | Integrate Monaco + MCP server validation |
27+
28+
### Deferred Strategic Improvements (Soon)
29+
30+
| ID | Task | Priority | Notes |
31+
|----|------|----------|-------|
32+
| 1.3 | Product landing pages by role | Medium | CTO, Architect, Developer pages |
33+
| 1.4 | Comparison pages | Medium | RIDDL vs OpenAPI/AsyncAPI/UML |
34+
| 1.5 | Demo video | High | 3-5 min screen recording with voiceover |
35+
| 2.2 | Troubleshooting/FAQ | Medium | Seed from riddl-mcp-server idioms |
36+
| 2.3 | Changelog links | Low | Link to GitHub releases |
37+
| 2.4 | Learning paths | Medium | Beginner → Intermediate → Advanced |
38+
| 2.5 | Mermaid diagrams | Low | Enable in mkdocs.yml, add to concepts |
39+
| 3.3 | Social proof | Medium | Testimonials when available |
40+
| 3.4 | Newsletter signup | Low | Mailchimp/ConvertKit embed |
41+
| 4.1 | Community (Discord/GH) | Medium | GitHub Discussions or Discord |
42+
| 4.4 | Page feedback | Low | "Was this helpful?" buttons |
43+
| 5.2 | PDF export | Low | mkdocs-pdf plugin |
44+
| 5.3 | API documentation | Medium | OpenAPI spec for MCP server |
45+
| 6.2 | Pricing page | Medium | When Synapify pricing finalized |
46+
| 6.3 | Contact form | Low | Replace email link with form |
47+
48+
**Note:** Blog/news (3.2) will be on www.ossuminc.com or LinkedIn, not here.
2349

2450
### Lower Priority
2551

2652
| Task | File | Notes |
2753
|------|------|-------|
2854
| Type examples | `references/language-reference.md` | Add specialized examples |
29-
| Quick-start tutorial | New file | Optional getting started guide |
3055
| Future work review | `future-work/` | Update for current roadmap |
3156
| EBNF grammar validation | `references/ebnf-grammar.md` | See details below |
3257
| Synapify generation docs | `synapify/generation.md` | Use preserved config |

docs/MCP/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "RIDDL MCP Server"
3+
description: >-
4+
Connect AI assistants to RIDDL via the Model Context Protocol. Enable
5+
validation, analysis, and intelligent suggestions for domain modeling.
6+
---
17
# RIDDL MCP Server
28

39
The RIDDL MCP Server is a Model Context Protocol (MCP) server that enables

docs/OSS/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Open Source Tools"
3+
description: >-
4+
Free and open source tools for RIDDL development. IDE extensions for
5+
IntelliJ and VS Code, authoring guides, and MCP server integration.
6+
---
17
# Ossum Open Source Software
28

39
Ossum Inc. provides open source tools for working with the RIDDL language.

docs/about/index.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,85 @@
11
---
2-
title: "About"
2+
title: "About Ossum Inc."
3+
description: >-
4+
Learn about Ossum Inc., the company behind RIDDL and the mission to make
5+
distributed system design accessible to everyone.
36
---
7+
# About Ossum Inc.
8+
9+
**Ossum Inc.** builds tools that make designing distributed systems accessible
10+
to domain experts—not just seasoned architects.
11+
12+
---
13+
14+
## Our Mission
15+
16+
Complex software systems are hard to build. The gap between what business
17+
experts understand and what developers implement is where projects fail.
18+
Requirements get lost in translation, designs drift from intent, and systems
19+
end up solving yesterday's problems.
20+
21+
We believe there's a better way.
22+
23+
**RIDDL** (Reactive Interface to Domain Definition Language) bridges this gap
24+
by providing a specification language that domain experts can read and
25+
contribute to, while being precise enough for AI-assisted code generation.
26+
It's Domain-Driven Design made practical.
27+
28+
---
29+
30+
## The Story
31+
32+
RIDDL began in 2019, born from decades of experience building large-scale
33+
distributed systems. After watching project after project struggle with the
34+
same problems—miscommunication between business and technical teams, designs
35+
that couldn't keep up with changing requirements, implementations that drifted
36+
from specifications—founder Reid Spencer started asking: *What if the
37+
specification itself was the source of truth?*
38+
39+
The first commits landed in late 2021. Reactific Software LLC, the original
40+
home of RIDDL, was acquired by Ossum Inc. in 2022 to continue the vision:
41+
making distributed system design accessible to everyone who understands the
42+
domain, not just those who can write code.
43+
44+
---
45+
46+
## What We Build
47+
48+
### Open Source
49+
50+
- **[RIDDL](../riddl/index.md)** – The specification language and compiler
51+
- **[IDE Extensions](../OSS/index.md)** – VS Code and IntelliJ support
52+
- **[Synapify](../synapify/index.md)** – Professional modeling workbench with
53+
visual editing, simulation, and code generation
54+
55+
### Commercial
56+
57+
- **[MCP Server](../MCP/index.md)** – AI assistant integration
58+
59+
---
60+
61+
## The Team
62+
63+
RIDDL exists because of the contributions of many, but it was initiated by:
64+
65+
**Reid Spencer** - Founder & Chief Architect
66+
: Deeply experienced system architect, software developer, and entrepreneur.
67+
Initiated RIDDL in 2019 and founded Ossum Inc. to bring it to market.
68+
[LinkedIn](https://www.linkedin.com/in/reidspencer)
69+
70+
See [Who Made RIDDL Possible](../riddl/introduction/who-made-riddl-possible.md)
71+
for the full list of contributors and the foundational work RIDDL builds upon.
72+
73+
---
74+
75+
## Contact
76+
77+
- **Support**: support@ossuminc.com
78+
- **GitHub**: [github.com/ossuminc](https://github.com/ossuminc)
79+
- **LinkedIn**: [linkedin.com/company/ossum-inc](https://www.linkedin.com/company/ossum-inc/)
80+
81+
---
82+
83+
## Legal
484

585
- [Privacy Policy](privacy-policy.md)

docs/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
title: "Ossum!"
2+
title: "Ossum Technologies"
3+
description: >-
4+
Documentation for RIDDL, a specification language for distributed reactive
5+
systems. Explore tools, guides, and references for domain-driven design.
36
---
4-
# Welcome To Ossum Technology!
7+
# Welcome To Ossum Inc.'s Technology!
58

69
This site provides documentation for technologies created at Ossum, Inc.
710

0 commit comments

Comments
 (0)