Based on analysis of eclipse-score/docs-as-code, we should explore adding documentation generation capabilities to Rivet similar to their Sphinx-based approach.
Features from docs-as-code that could be valuable for Rivet:
- Automated documentation generation from YAML artifacts
- Custom Sphinx extensions for:
- Decision record linking (decision_record.md)
- UML diagram generation from PlantUML
- Header/service documentation
- Layout customization
- Metamodel visualization
- Source code linking
- Sphinx bundling
- TOML synchronization
- Support for multiple build strategies (links vs copies)
- Integration with version control for traceability
- Local multi-module build capabilities
- Extensible metamodel support
We should consider implementing similar documentation generation features in Rivet, potentially:
- YAML-to-documentation conversion pipeline
- Custom traceability report generation
- Integration with static site generators
- Configurable documentation templates
- Version-aware linking between artifacts
Based on analysis of eclipse-score/docs-as-code, we should explore adding documentation generation capabilities to Rivet similar to their Sphinx-based approach.
Features from docs-as-code that could be valuable for Rivet:
We should consider implementing similar documentation generation features in Rivet, potentially: