[12/01/2023]: Migrating the Project documentation to Quarto.

[sandygudie]

Summary

Migration of JSDocs Project documentation to Quarto.

Goals

• Structured navigation.
• Mutillingual support.
• API documentation.

Todos

• Review existing JsDocs documentation (https://moocs-documentation.netlify.app/).
• Set up Quarto documentation respository with structured project folder and styling pattern.
• Set up navigation pattern for documentation.
• Install babelquarto for mutillingual support.
• Move JsDoc content to Quarto.
• Add all contributors.
• Write function references (API documentation using quartodoc).
• Include documentation on migrating from JsDoc to Quarto.

Resources and examples

• https://docs.ropensci.org/babelquarto/ (support multilingual)
• Documentation structure example
• How do I use Quarto as replacement for JSDocs to create documentation for my JavaScript Projects? quarto-dev/quarto-cli#8163 (Question posted in Quarto)
• Add all-contributors
• quartodoc- Generate API documentation with Quarto
• Function reference examples

[BatoolMM]

Thank you @sandygudie for creating this issue.

What do you think TODO's steps in exploring this issue? so we can add them as TODO's?

[sandygudie]

I have added a couple of "Todos" in mind, we will keep expanding on it as time goes on.

@BatoolMM @RealRichi3 Please feel free to add suggestion if you have any.

[BatoolMM]

Let's discuss these steps in today's meeting - I am happy to take over installing babelquarto for mutillingual support - the package uses R.

[BatoolMM]

I think we need to build a tool similar to this one that can covert doc string in the API to Markdown using config file. I will strat a new repo.

[BatoolMM]

I have created a blank repository here

[BatoolMM]

@sandygudie @RealRichi3 I have created a new repo here Open-Science-Community-Saudi-Arabia/Open-Innovation-Docs#1

I would also like to deploy the new translation for the front-end of the MOOCs #311 so I can add it in the IOI presentation this Friday - can you have a look at it, pls?