Overhaul docs using something like GitHub Pages

[markshust]

See https://gibinfrancis.medium.com/creating-structured-multi-page-documentation-with-github-pages-794b100a4941

[markshust]

GitBook may be a good option: https://www.gitbook.com/

Anyone else have suggestions on what documentation platform to use? The only requirement is keeping it editable via GitHub so anyone can contribute to the docs.

[TerrorSquad]

Hey @markshust

I would also recommend Docus https://docus.dev/ It's built with Nuxt, is open-source, has integrated fuzzy search, and allows editing doc files in Markdown files, similar to GitBook, allowing anyone to contribute.

I'm using it for my project https://terrorsquad.github.io/ansible-post-installation/ and it's quite nice.

[markshust]

Thanks for the recommendation @TerrorSquad! That site looks great.

I'll see what I can do coming up here.

[hans2103]

and what about Astro CMS https://astro.build/

DOCS look like this: https://docs.astro.build/en/getting-started/ Works nice too.

[markshust]

@hans2103 My personal site actually runs on Astro, and while cool and seemingly good at the start, it feels like it tends to slow down a bit with large numbers of files. I'll take an additional look at it though, as my site was built a few years back, and I'm sure the build process and loading speeds have probably improved dramatically since.

[damienwebdev]

I really like Vitepress https://vitepress.dev/

[dosubot[bot]]

Hi, @markshust. I'm Dosu, and I'm helping the docker-magento team manage their backlog and am marking this issue as stale.

Issue Summary:

• You proposed revamping the documentation into a structured multi-page format using GitHub Pages for better organization and accessibility.
• Several contributors suggested various documentation platforms like GitBook, Docus, Astro CMS, and Vitepress, all supporting Markdown and GitHub-based editing.
• You showed interest in exploring these options further to find the best fit for enhancing the docs.
• The discussion has remained focused on selecting the ideal platform but no final decision or implementation has been made yet.

Next Steps:

• Please let me know if this issue is still relevant to the latest version of the docker-magento repository by commenting here.
• If I don’t hear back within 30 days, this issue will be automatically closed to keep the backlog manageable.

Thanks for your understanding and contribution!