Skip to content

Commit 0767c1d

Browse files
respencer-nclclaude
andcommitted
Save session state
Update CLAUDE.md and NOTEBOOK.md with Synapify documentation work: - Expanded repository structure to show new Synapify files - Updated documentation status for Synapify section - Logged favicon and documentation work completed this session - Added design decisions about Synapify architecture Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 1a6b6e2 commit 0767c1d

2 files changed

Lines changed: 57 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ ossum.tech/
3434
│ │ ├── authoring-riddl.md # Common RIDDL authoring guide
3535
│ │ ├── intellij-plugin/ # IntelliJ IDEA plugin docs
3636
│ │ └── vscode-extension/# VS Code extension docs
37-
│ ├── synapify/ # Synapify visual editor docs (coming soon)
37+
│ ├── synapify/ # Synapify visual editor docs
38+
│ │ ├── index.md # Overview and getting started
39+
│ │ ├── user-interface.md # Four-panel UI documentation
40+
│ │ ├── simulation.md # riddlsim integration (coming soon)
41+
│ │ └── generation.md # riddl-gen integration (coming soon)
3842
│ └── about/ # Company info, privacy policy
3943
├── overrides/ # MkDocs theme customizations
4044
├── mkdocs.yml # MkDocs configuration
@@ -158,7 +162,7 @@ See [Domain concepts](../concepts/domain.md) for more details.
158162

159163
## Documentation Status
160164

161-
As of 2026-01-21, documentation is complete for all major sections:
165+
As of 2026-01-26, documentation is complete for all major sections:
162166

163167
### Completed Sections
164168

@@ -170,7 +174,8 @@ As of 2026-01-21, documentation is complete for all major sections:
170174
- **Concepts**: All concept pages complete with proper links
171175
- **OSS**: IDE extension documentation with authoring guide
172176
- **MCP**: Installation guides for 6 AI tools (Claude, Gemini, Copilot, etc.)
173-
- **Synapify**: Overview documentation (product in development)
177+
- **Synapify**: Comprehensive user guide with UI, simulation, and generation
178+
documentation (features marked "Coming Soon" where in development)
174179

175180
### Placeholders
176181

NOTEBOOK.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,48 @@ All changes pushed to origin/main.
1313

1414
## Work Completed (Recent)
1515

16+
### 2026-01-26: Synapify User Guide Expansion
17+
18+
Comprehensive expansion of Synapify documentation based on product discussion:
19+
20+
- [x] **Favicon Update**
21+
- Downloaded favicon from www.ossuminc.com (32x32, 192x192, 180x180 sizes)
22+
- Created template override (`overrides/main.html`) with proper link tags
23+
- Updated mkdocs.yml to use new favicon
24+
25+
- [x] **Synapify Index Rewrite** (`docs/synapify/index.md`)
26+
- "The Solution Architect's Toolbench" tagline
27+
- Sections targeting all four user types (Domain Experts, Authors,
28+
Implementors, Developers)
29+
- Core capabilities overview (visual editor, text editor, project
30+
management, validation)
31+
- Integrated services (simulation, generation, AI) with Coming Soon markers
32+
- Subscription tiers outline (Individual, Team, Enterprise)
33+
34+
- [x] **User Interface Guide** (`docs/synapify/user-interface.md`)
35+
- Accurate four-panel layout documentation:
36+
- Left: Model Tree (AST hierarchy navigation, hideable)
37+
- Center top: Visual Editor (primary, always visible)
38+
- Center bottom: Text Editor (Monaco, hideable)
39+
- Right: Metadata & Info (with clause editing, statistics, hideable)
40+
- Panel visibility controls and suggested layouts
41+
- Keyboard shortcuts reference
42+
43+
- [x] **Simulation Guide** (`docs/synapify/simulation.md`)
44+
- How riddlsim integration works (HTTP requests, streaming results)
45+
- Scenario structure and examples
46+
- Running single scenarios and suites
47+
- Understanding results and common issues
48+
- Integration with development workflow
49+
50+
- [x] **Code Generation Guide** (`docs/synapify/generation.md`)
51+
- How riddl-gen integration works
52+
- Documentation targets (AsciiDoc, Hugo)
53+
- Code targets (Akka/Scala, Quarkus/Java planned)
54+
- Structure mapping from RIDDL to generated artifacts
55+
- Iterative development workflow
56+
- Deep dive examples
57+
1658
### 2026-01-21: Synapify Documentation
1759

1860
- [x] **Synapify Overview** (`docs/synapify/index.md`)
@@ -111,6 +153,10 @@ None currently.
111153

112154
| Decision | Rationale | Date |
113155
|----------|-----------|------|
156+
| Synapify four-panel layout | Left=tree, center=visual+text, right=metadata; 3 hideable | 2026-01-26 |
157+
| Visual editor primary | Cannot be hidden; text editor secondary and synchronized | 2026-01-26 |
158+
| riddlsim via HTTP | Synapify sends model/scenarios, riddlsim streams results | 2026-01-26 |
159+
| riddl-gen separate service | Will be at gen.ossuminc.com; handles code generation | 2026-01-26 |
114160
| Synapify "Coming Soon" | Product in development; document planned features | 2026-01-21 |
115161
| Separate MCP section | MCP is distinct from IDE plugins; deserves own nav | 2026-01-21 |
116162
| Per-tool MCP guides | Each AI tool has unique config; separate pages clearer | 2026-01-21 |
@@ -121,13 +167,9 @@ None currently.
121167

122168
| Hash | Description |
123169
|------|-------------|
124-
| `74af346` | Add RIDDL images and update documentation structure |
125-
| `d22d2af` | Add RIDDL authoring guide for IDE users |
126-
| `d4bd9f2` | Complete IDE extension documentation for OSS release |
127-
| `c2a735d` | Add MCP section with AI tool integration guides |
128-
| `d5dc12c` | Update site index and OSS landing page |
129-
| `0d99dd1` | Update engineering notebook with OSS release work |
130-
| `4cb9e4a` | Add comprehensive Synapify documentation |
170+
| `0922e1d` | Update favicon to match www.ossuminc.com |
171+
| `d6d7896` | Add multiple favicon sizes and proper link tags |
172+
| `1a6b6e2` | Add comprehensive Synapify user documentation |
131173

132174
## Open Questions
133175

0 commit comments

Comments
 (0)