Skip to content

Commit d5dc12c

Browse files
respencer-nclclaude
andcommitted
Update site index and OSS landing page
- Fix broken link to OSS section (case mismatch) - Fix typo in index.md - Add MCP Server to main navigation - Update OSS index with links to all products - Add getting started workflow Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c2a735d commit d5dc12c

2 files changed

Lines changed: 82 additions & 16 deletions

File tree

docs/OSS/index.md

Lines changed: 77 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,87 @@
11
# Ossum Open Source Software
22

3-
In this section you will find open source software released by Ossum Inc. Feel free to try it out! There is no charge
4-
for using this Ossum software!
3+
Ossum Inc. provides open source tools for working with the RIDDL language.
4+
All software is free to use under the Apache License 2.0.
55

6-
Here are the open source projects:
6+
## IDE Extensions
77

8-
* [RIDDL](./riddl/index.md)
9-
* [VS Code Extension For RIDDL](./vscode-extension/index.md)
10-
* [IntelliJ IDEA Plugin](./intellij-plugin/index.md)
8+
### [IntelliJ IDEA Plugin](./intellij-plugin/index.md)
9+
10+
RIDDL language support for JetBrains IntelliJ IDEA, including:
11+
12+
- Syntax highlighting with customizable colors
13+
- Real-time validation and error detection
14+
- Integrated RIDDL tool window
15+
- Clickable error navigation
16+
17+
**Status**: Beta - [Download](https://github.com/ossuminc/riddl-idea-plugin/releases)
18+
19+
### [VS Code Extension](./vscode-extension/index.md)
20+
21+
RIDDL language support for Visual Studio Code, including:
22+
23+
- Syntax highlighting with semantic tokens
24+
- IntelliSense code completion (50+ keywords)
25+
- Real-time diagnostics
26+
- Go to Definition and Find References
27+
- Hover documentation
28+
29+
**Status**: Beta - [Download](https://github.com/ossuminc/riddl-vscode/releases)
30+
31+
---
32+
33+
## Writing RIDDL
34+
35+
### [Authoring RIDDL Sources](./authoring-riddl.md)
36+
37+
A comprehensive guide to writing effective RIDDL source files, covering:
38+
39+
- File organization and includes
40+
- Adding metadata with the `with` clause
41+
- Type definitions and references
42+
- Commands, events, queries, and results
43+
- Entity design patterns
44+
- Handler statements
45+
- Common patterns and best practices
46+
47+
This guide applies to any IDE or editor.
1148

1249
---
1350

14-
If you have any questions or need assistance, please contact our support team at support@ossuminc.com
51+
## AI-Assisted Modeling
52+
53+
### [RIDDL MCP Server](../MCP/index.md)
54+
55+
Connect AI assistants to the RIDDL MCP Server for intelligent modeling
56+
assistance:
57+
58+
- Validate RIDDL code with detailed error messages
59+
- Check model completeness and get suggestions
60+
- Convert natural language to RIDDL structures
61+
- Get explanations for validation errors
62+
63+
Supports: Claude Desktop, Claude Code, Gemini CLI, VS Code Copilot,
64+
IntelliJ AI Assistant, and IntelliJ Junie.
65+
66+
---
67+
68+
## Getting Started
69+
70+
1. **Install an IDE extension** for your preferred editor
71+
2. **Read the authoring guide** to learn RIDDL best practices
72+
3. **Connect the MCP server** for AI-assisted modeling (optional)
73+
74+
---
75+
76+
## Support
77+
78+
If you have questions or need assistance:
1579

16-
If you are interested in contributing to our open source projects, please visit our GitHub organization at
17-
https://github.com/ossuminc.
80+
- **Email**: support@ossuminc.com
81+
- **GitHub**: [github.com/ossuminc](https://github.com/ossuminc)
1882

83+
## Contributing
1984

85+
We welcome contributions to all open source projects. Visit the GitHub
86+
repositories linked above to report issues, suggest features, or submit
87+
pull requests.

docs/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@ title: "Ossum!"
55

66
This site provides documentation for technologies created at Ossum, Inc.
77

8-
THe sections at the top correspond to our products:
9-
10-
* [OSS](oss/index.md)
11-
* [RIDDL](riddl/index.md)
12-
* [Synapify](synapify/index.md)
13-
* [Docify](docify/index.md)
14-
* [Verify](verify/index.md)
8+
The sections at the top correspond to our products:
159

10+
* [RIDDL](riddl/index.md) - General documentation about the core language behind all products
11+
* [MCP Server](MCP/index.md) - Documentation for the MCP Server, a REST API for managing RIDDL models
12+
* [OSS](OSS/index.md) - A collection of open source tools to aid in RIDDL modeling
13+
* [Synapify](synapify/index.md) - The user interface for RIDDL models
1614

1715
# Information
1816
* Author: Ossum Inc.

0 commit comments

Comments
 (0)