How to export Swimm documents to Backstage TechDocs

To allow Backstage TechDocs to display Swimm documents, please follow the instructions below:

Overview​

1. In the mkdocs.yml, update the docs_dir parameter to the .swm folder in the root level of the repository.
   • If no nav option is provided, it'll show a flat hierarchy with all of the Swimm documents in a certain repository.
   • Alternatively, you can point to a specific document and build your own navigation.

2. Create a README.md or index.md file in the .swm folder of the repo.
   • This is an MkDocs requirement that will be the entry point for the documentation.

(Optional) Currently, the .swm is flat in hierarchy. We can look to export the structure of folders created in repositories within Swimm's web app, if needed.

• Potential automation for a Swimm playlist or doc always copied to a specific path.

Rendering Mermaid graphs in the TechDocs:​

Please follow the instructions for the TechDocs Addon, backstage-plugin-techdocs-addon-mermaid, which allows rendering of Mermaid diagrams within Backstage TechDocs.