convert tutorials written in Markdown syntax into SST's preferred documentation format

[bhpayne]

Tutorials in Markdown are not compatible with SST's approach.

What is the process for converting Markdown to what SST wants?

[bhpayne]

SST created a new repo, https://github.com/sstsimulator/sst-documentation

[bhpayne]

Sandia says

Sandia has a Python converter built around the PlasTeX package. It was bootstrapped by LPS and Sandia has been getting it to the point where it can format all the existing documentation in both LaTeX and Markdown. It’s not on github, but Sandia is in the process of determining whether Sandia can put it there or some other platform. Sandia prefers a PlasTeX-based approach rather than relying on Sandia manually checking the formatting of submissions.

Documentation plans:

• Sandia has a new set of pages (not pushed yet) that documents all of the Python API (components, links, statistics, etc.)
• Sandia has documentation on subcomponents and how to use them. That is a work in progress.

The goal is to dump at least the API documentation into a PDF manual and publish that with releases

Website plans:

The main SST website (sst-simulator.org) is built in github pages, the “documentation site” (sst-simulator.org/sst-website) is built on Docusaurus. There are some (generally minor) differences in the markdown and formatting.

• Sandia is finishing up the Docusaurus v1 -> v2 migration
• There is a PR waiting for that migration to clean up some odds and ends on the documentation site (broken links, eliminate duplication, etc.)
• Sandia has reviewed all the pages on the sst website for which domain they belong on and will be moving things around
  • The goal is that all user/developer documentation (how-tos, API doc, etc.) lives on the “sst-website” subdomain. That site will also get relocated to something logical like “sst-simulator.org/docs”.
  • All other stuff – announcements/releases/links to downloads/etc. are staying in their current github pages format for now.