SUPER-EPIC: Comprehensive Documentation Enhancement

[robertwol]

Epic Description:
The goal of this epic is to provide a comprehensive, updated, and user-friendly documentation for the Open Component Model (OCM) and its associated tooling. This will involve improving the existing documentation, updating it to reflect recent changes, and creating new guides and tutorials.
The documentation will cover various aspects of OCM, including technical details, user manuals, troubleshooting guides, and use cases. It will cater to different audiences, from end users to developers, and will be made available on multiple platforms, including the OCM website and VS Code extension.
This epic will also focus on improving the contributors' documentation to encourage and facilitate more contributions to the OCM project. Additionally, it will involve creating and improving documentation for the MPAS and OCM controllers.

The completion of this epic will ensure that all users have access to the information they need to effectively use and contribute to the OCM and its associated tools.

Related Tasks

• EPIC: Improve End User documentation for OCM CLI #119
• Update the documentation to reflect changes done during refactoring for Go naming convention  #112
• Update the documentation to reflect changes at OCM library interfaces #117
• EPIC: Create OCM CLI / Lib Developer Documentation #124
• Create OCM Library developer documentation #132
• EPIC: Improve OCM Spec #137 (own EPIC)
• Improve OCM Controllers' Documentation ocm-controller#235
• Improve Open Component Model (OCM) Specification ocm-spec#60
• Add GitHub action to check markdown files for broken links #214

Contribution

• Improve Contributors Documentation for OCM Project #109

Website

• Website documentation for controllers #87
• Documentation alignment on controllers and website #169

VS Code

• VSCode Extension: End User Documentation enhancement #89

MPAS

• MPAS Documentation Website #49
• MPAS documentation #52

Done Criteria

• All subtasks from above are done
• Successful demonstration/discussion in Review

[morri-son]

closed as new EPICs for the major parts have been created. The remaining issues will stay without an own Epic.