Documenting the RSD as a service covers the following types of documentation:

  • Requirements documentation: Get started.
  • Architecture and Technical documentation: a global picture of the technology stack plus code-based helper comments.
  • End-user documentation: organizations and user guides.

Documenting the RSD

It is required to always update the documentation when needed as defined in the pull request template.

This documentation site

We use Vuepressopen in new window to populate this documentation site.
Is based on Markdown files with extra features supported like HTML in markdown, components, frontmatter, etc.
you can run the project locally following the getting-started stepsopen in new window