Skip to content

Commit 4cb9e4a

Browse files
respencer-nclclaude
andcommitted
Add comprehensive Synapify documentation
Document planned features for the visual RIDDL editor: - Visual and textual editing modes - Automatic diagram generation (context maps, entity diagrams, etc.) - AI integration via MCP Server - Model simulation capabilities - Code generation (coming soon) - Getting started guide and requirements Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 0d99dd1 commit 4cb9e4a

1 file changed

Lines changed: 150 additions & 1 deletion

File tree

docs/synapify/index.md

Lines changed: 150 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,152 @@
11
# Synapify
22

3-
Synapify is the editor for creating system models based on [RIDDL](../riddl/index.md)
3+
Synapify is the visual editing interface for creating and managing
4+
[RIDDL](../riddl/index.md) domain models. It combines powerful editing
5+
capabilities with AI assistance to streamline your model development
6+
workflow.
7+
8+
!!! warning "Coming Soon"
9+
Synapify is currently in active development. Features described below
10+
represent the planned capabilities. Check back for updates on
11+
availability.
12+
13+
---
14+
15+
## Overview
16+
17+
Synapify provides a complete environment for domain modeling with RIDDL:
18+
19+
- **Visual and Textual Editing** - Switch between graphical diagrams and
20+
source code views
21+
- **Automatic Diagram Generation** - Visualize your model structure
22+
automatically
23+
- **AI-Powered Assistance** - Integrated with your AI and Ossum's MCP Server
24+
- **Model Simulation** - Request simulations to validate model behavior
25+
- **Code Generation** - Generate implementation code from your models (coming
26+
soon)
27+
28+
---
29+
30+
## Editing Modes
31+
32+
### Graphical View
33+
34+
Visualize your domain model as interactive diagrams:
35+
36+
- **Domain hierarchy** - See contexts, entities, and their relationships
37+
- **Message flows** - Trace commands, events, and queries between components
38+
- **Type structures** - View aggregations and type definitions graphically
39+
- **Drag-and-drop editing** - Modify your model visually
40+
41+
### Textual View
42+
43+
Full-featured RIDDL source editor:
44+
45+
- **Syntax highlighting** - Clear visual distinction of language elements
46+
- **Real-time validation** - Immediate feedback on errors and warnings
47+
- **Code completion** - Intelligent suggestions as you type
48+
- **Synchronized views** - Changes in text update diagrams automatically
49+
50+
---
51+
52+
## Diagram Generation
53+
54+
Synapify automatically generates diagrams from your RIDDL model:
55+
56+
| Diagram Type | Shows |
57+
|--------------|-------|
58+
| **Context Map** | Bounded contexts and their relationships |
59+
| **Entity Diagram** | Entities, their state, and message handlers |
60+
| **Message Flow** | How messages move between components |
61+
| **Type Hierarchy** | Type definitions and their relationships |
62+
| **Saga Workflow** | Multi-step process coordination flows |
63+
64+
Diagrams update in real-time as you edit your model.
65+
66+
---
67+
68+
## AI Integration
69+
70+
Synapify integrates with AI assistants through Ossum's
71+
[MCP Server](../MCP/index.md) to provide intelligent modeling support:
72+
73+
### Capabilities
74+
75+
- **Validate models** - Get detailed feedback on errors and warnings
76+
- **Check completeness** - Identify missing elements in your model
77+
- **Generate suggestions** - Receive recommendations for what to add next
78+
- **Explain errors** - Understand validation issues with fix suggestions
79+
- **Convert descriptions** - Transform natural language into RIDDL structures
80+
81+
### How It Works
82+
83+
1. Connect your preferred AI assistant (Claude, Gemini, Copilot, etc.)
84+
2. Configure the RIDDL MCP Server connection
85+
3. Ask questions or request assistance directly in Synapify
86+
4. AI responses include proper RIDDL syntax ready to insert
87+
88+
---
89+
90+
## Model Simulation
91+
92+
Request simulations to validate your model's behavior before implementation:
93+
94+
- **Behavioral validation** - Verify handlers respond correctly to messages
95+
- **State transitions** - Confirm entities move through expected states
96+
- **Saga coordination** - Test multi-step process flows
97+
- **Edge cases** - Explore boundary conditions and error scenarios
98+
99+
Simulation results help you refine your model before committing to code.
100+
101+
---
102+
103+
## Code Generation
104+
105+
*Coming soon*
106+
107+
Generate implementation code from your validated RIDDL models:
108+
109+
- Target multiple languages and frameworks
110+
- Produce type-safe message definitions
111+
- Create entity implementations with handlers
112+
- Generate API endpoints and documentation
113+
114+
---
115+
116+
## Getting Started
117+
118+
When Synapify becomes available:
119+
120+
1. Download and install Synapify
121+
2. Create or open a RIDDL project
122+
3. Connect to the MCP Server for AI assistance
123+
4. Start modeling with visual or textual editing
124+
5. Generate diagrams to visualize your design
125+
6. Run simulations to validate behavior
126+
127+
---
128+
129+
## Requirements
130+
131+
- **Platform**: macOS, Windows, Linux
132+
- **MCP Server**: For AI integration features
133+
- **Network**: For simulation and code generation services
134+
135+
---
136+
137+
## Stay Updated
138+
139+
Synapify is under active development. For updates:
140+
141+
- **Lined In**: Follow us here: https://www.linkedin.com/company/ossum-inc/
142+
- **Email**: Ask a question here: support@ossuminc.com
143+
- **List**: Join email list here: https://www.ossuminc.com/ (scroll down)
144+
- **GitHub**: Developers: [github.com/ossuminc](https://github.com/ossuminc)
145+
146+
---
147+
148+
## Related Documentation
149+
150+
- [RIDDL Language Reference](../riddl/references/language-reference.md)
151+
- [Authoring RIDDL Sources](../OSS/authoring-riddl.md)
152+
- [MCP Server Integration](../MCP/index.md)

0 commit comments

Comments
 (0)