Create a table of contents for this documentation website

[ryanspilker]

Summary

• Creates a documentation table of contents based on Draft B
• Adds concise descriptions of the existing documentation pages

Current scope

The SimVascular documentation is not yet consistently organized according to the Diátaxis framework. Existing pages can contain combinations of tutorial, how-to, reference, and explanatory material. This pull request does not attempt to classify or restructure all of that content. It provides a clearer table of contents for the pages that currently exist while avoiding categories that could imply a more complete organization than the website presently has.

Future direction

In follow-up issues, we can inventory the current material and progressively improve its organization around the four Diátaxis documentation types: tutorials, how-to guides, (technical) reference, and explanation (theory guide). The table of contents should evolve as that work clarifies the purpose and placement of each page.

Note that the third step in the beginner sequence currently links to the beta CFD Simulation Tool documentation. Work associated with #59 can replace that destination with the simulation portion of the Getting Started tutorial once the current workflow has been tested and documented.

Closes #89

Code of Conduct & Contributing Guidelines

• I agree to follow the Code of Conduct and Contributing Guidelines.

[ktbolt]

@ryanspilker Should the New Users / Open the Getting Started Tutorial link instead be New Users / Getting Started ?

Jumping right to the tutorial doesn't provide any context to what is going on in the Tutorial.

[ktbolt]

Change Complete a first SimVascular project to Create SimVascular Project; the text below provides more context.

[ktbolt]

The Complete model tutorial links to the Getting Started Tutorial when it should link to the Modeling section.

[ktbolt]

@ryanspilker I'm not sure about including SimCardio documentation; think that all that is outdated maybe.

[ryanspilker]

@ktbolt Thanks for the suggestions. I updated the New Users callout so that it links to the beginning of the Getting Started page rather than jumping directly to the tutorial. The callout encourages new users to start there and read the introductory context before beginning the tutorial.

I also changed the section heading and sidebar label to “Create SimVascular Project”.

For the middle step, I kept the link to the Getting Started tutorial but clarified its purpose. This step now encourages users to work through the currently up-to-date anatomic modeling portion of the tutorial, from medical image data through creation of a finite element mesh.

The final step currently links to the CFD Simulation Tool page. As part of #59, I plan to complete and verify the simulation portion of the Getting Started tutorial and then change this final step to link directly to that material. The three-step sequence will therefore guide a new user from installation, through anatomic modeling, to a first hemodynamic simulation.

I also removed SimCardio from this table of contents for now. I left the existing SimCardio page and global navigation unchanged until we determine which material is outdated and how it should be handled.