Create GitHub documentation page to visualize existing markdown docs

[mmurad2]

Is your feature request related to a problem? Please describe. Improve documentation accessibility.

Describe the solution you'd like A dedicated Github documentation page that will serve as a centralized hub to visualize and navigate through the existing markdown documentation files.

Tasks

• [ ] Investigate and select a documentation framework/tool, ideally one that works with GitHub Pages.
• [ ] Set up the chosen tool in the repository.
• [ ] Configure the documentation tool to generate pages from the existing markdown files.
• [ ] Test the documentation page to ensure that it is user-friendly and correctly displays the markdown content.
• [ ] Set up CI to automatically deploy updates to the documentation site.
• [ ] Write basic guidelines for future contributions to the documentation.

[eduardconstantin]

Hello! I found this: https://docsify.js.org

[mmurad2]

Thanks! @Tomas2D do you have a preference on this framework vs just building with GitHub Pages directly. Also @eduardconstantin would you like me to assign the ticket to you?

[eduardconstantin]

Yes, I would like to work on this. The tool I found deploys the markdown files to GitHub pages. It only needs an index.html to render content from those files.

[Tomas2D]

Hello Eduard, the docsify.js looks good to me. It seems simple and provides deployment to GitHub pages (which is crucial for us now). Would you consider any alternatives besides the mentioned docsify.js?

[matoushavlena]

These were some historic considerations for a standalone doc site (not in any order of preference): https://www.mkdocs.org/ https://docs.readme.com/main/docs/rdme https://www.markdownguide.org/ https://markdoc.dev/ https://mintlify.com/ https://scalar.com/

@Tomas2D what's your thought? It would be good to understand if docsify is a short term solution or long term one.

[eduardconstantin]

I also found docusaurus, docz, gitbook

[Tomas2D]

docsify is a low hanging fruit; it is easy to set up and modify and an active project with many plugins.

@eduardconstantin, feel free to start

[eduardconstantin]

docsify is a long-hanging fruit; it is easy to set up and modify and an active project with many plugins.

@eduardconstantin, feel free to start

the best choice in the history of choices