Skip to main content

Introduction

Thank you for being a contributor to Superna's documentation!

Getting Started​

Superna's documentation is written in Markdown, and uses a docs-as-code strategy for review and publication. To get started, it is recommended to install the reference set of tools, as described on the Tools and Setup page

Writing Documentation​

Before starting to write, please consult the Style Guide and understand the conventions that Superna uses in this documentation.

Structure​

The documentation is separated by Solution. Each solution has a directory under solutions, and each solution has a structure of five directories:

  • Getting Started
  • Use Cases
  • Managing the Solution
  • Extras
  • User Help

Please conform to this structure as the documentation continues to grow.

Submitting for Review​

To submit changes for review, please read and follow the guide on Submitting Changes to submit any updates to the Superna team for review and publication.