Documentation Guides

The following guides are provided for people who want to understand or contribute to the ONAP documentation project.

• Introduction
• Setup of a Documentation Development System
• Style Guide (Content)
• Creating ReStructuredText
• Testing
• Converting to RST
• Updates and Review
• Migrating from blockdiag/seqdiag to Mermaid
• blockdiag/seqdiag to Mermaid Diagram Migration
• Migrating from sphinxcontrib-needs to sphinx-needs
• Removal of sphinx-toolbox from shared docs configuration
• API Documentation
• Advisory: JSON Pointer Errors in OpenAPI Spec Files
• Templates