Skip to content

Documentation Generation Capabilities #12

@avrabe

Description

@avrabe

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:

  1. Automated documentation generation from YAML artifacts
  2. 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
  3. Support for multiple build strategies (links vs copies)
  4. Integration with version control for traceability
  5. Local multi-module build capabilities
  6. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions