Clean up documentation removing old content and links, fixing links, fix menus

[ktbolt]

We need to do a simple clean up of the documentation

1) Remove old content

2) Fix installation links

3) Fix menus

[ktbolt]

I've fixed some links and menus, and added a Online Tutorials header to the home page.

I am now rewriting the Quick Guide section, will simplify, change HINTS in red font to something less alarming, remove the DICOM Images section that explains how to read in images that will totally screw you, and spell SimVascular correctly.

[alisonmarsden]

Dave, While you’re at it, can you update the “workshops” section for 2021?

From: Dave Parker @.> Date: Thursday, June 3, 2021 at 9:48 PM To: SimVascular/simvascular.github.io @.> Cc: Subscribed @.***> Subject: Re: [SimVascular/simvascular.github.io] Clean up documentation removing old content and links, fixing links, fix menus (#70)

I've fixed some links and menus, and added a Online Tutorials header to the home page. [Screen Shot 2021-06-03 at 9 35 45 PM]https://user-images.githubusercontent.com/23109458/120746263-b2a0ba00-c4b3-11eb-8654-7254d5f6a62c.png

I am now rewriting the Quick Guide section, will simplify, change HINTS in red font to something less alarming, remove the DICOM Images section that explains how to read in images that will totally screw you, and spell SimVascular correctly.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/SimVascular/simvascular.github.io/issues/70#issuecomment-854355203, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ADJGJZY5456FG63Y7PPWRATTRBLIHANCNFSM46BH6HLQ.

[ktbolt]

@alisonmarsden I will update the workshops section for 2021.

[ktbolt]

I've rewritten most of the Introduction, finishing up the GUI section, documenting how the display menus work which even the MITK documentation does not explain!

No matter what some may think, creating html pages using a text editor is the way to go!

[ktbolt]

I've finished the GUI Display section

There is more work to do for the GUI Data Manager section, will do that next.

[ktbolt]

I've finished (for now) the GUI Data Manager and Tool Panel

As I write the documentation I am realizing how confusing the SV GUI is and how it doesn't work like other apps. This makes it more difficult and time consuming to document.

For example, the SV Path Planning and SV Modeling tabs in the Tool Panel scream out to you that you can switch between the SV Path Planning and SV Modeling Tool Panels.

But no, selecting the SV Path Planning tab brings up this

To show the SV Path Planning panel you must click in the Data Manager. Why even have those misleading tabs?

[ktbolt]

I've started the Tutorial section, using a table format to show the GUI and describing the inputs

I think this format will be OK.

What is really missing is a User Manual that describes all the controls for each Tool. That will be a lot more work, especially since it is not clear what many of the GUI controls do.

[ktbolt]

I've finished the Tutorial so I'm done with the first pass at this.

I'll now do a spell check and check for consistency and clarity.

[ktbolt]

I've fixed spelling mistakes and added a bit more content.

The source and master branches have been merged so it is now live!