[DOCS] Transitioning JuliaHealth Website to Documenter.jl

[TheCedarPrince]

Issue Description

Difficulty: Beginner

Time: 10 - 15 hours

Description: The aim of this issue is to support the major refactor beginning across all of JuliaHealth to improve discoverability and unity of the JuliaHealth ecosystem as it pertains to documentation. This issue's purpose is to provide guidance on how one will migrate the JuliaHealth website to Documenter.jl to support a more robust documentation ecosystem. It is part of the JuliaHealth Documentation Overhaul organization project.

Requirements

• Remove Franklin.jl dependency
• Migrate Franklin.jl syntax in pages to Documenter.jl syntax
• Add Documenter.jl dependency
• Make each page compatible with Documenter.jl
• Make sure the documentation page is deployed live on github pages
  • NOTE: JuliaHealth reviewers can help with this set-up
• Check links within website to make sure they are accurate

Expected Outcomes

After this transition is completed, the website should go from looking like this:

To a layout that looks more like this:

NOTE: Each main page of the JuliaHealth website should be on the left hand side of the Documenter.jl "drawer" as shown in the second photo.

Additional Notes

For how to approach this issue, I would suggest the following steps:

First, if you have never worked with Documenter.jl before, I would highly recommend these videos and resources:

• Documenter.jl Deep Dive
• Documenter.jl Official Documentation
• How To Locally Preview Documenter.jl Documentation

Next, I would recommend creating a practice folder (repository) on your computer to download Documenter to. From there, I would follow the above tutorials and guides to create a documentation website on your own computer from scratch. Once you know how to create a documentation website, how to add pages, and how to write documentation for the website, you are ready for the next step!

Second, I would then create a fork of the JuliaHealth website. Within this fork, I would add Documenter.jl to this fork and remove Franklin.jl. You can do this from within the Julia REPL. Then, the major work begins by slowly migrating each page and entry from the JuliaHealth website to the Documenter.jl layout. This will take some time here!

Third, once you are done with this, go ahead and open a Pull Request with all your changes saved to your fork. At this point, myself or someone from within JuliaHealth (maybe @Jay-sanjay or @DilumAluthge) will review this PR to suggest changes or help with fixes. There will need to be some additional tweaks to make the documentation live by the JuliaHealth administrators so at that point, we will help to make sure it is live.

Then, you should be done with this PR!

Other Resources

Julia Slack:

• documentation channel - you should post here first
• helpdesk channel - this would be to get more attention to your issue but maybe not as precise as you need.
• health-and-medicine channel - this is where most of JuliaHealth is located these days.

Julia Discourse - I would advise posting here if you have an issue that you feel is long or requires a lot of time to explain as you might lose it within Julia Slack. Consider cross-posting your forum post to the Julia Slack in helpdesk and/or documentation.