I’ve been spending some time with the documentation in the /docs folder and noticed we have some great content that might be even more accessible if hosted as a dedicated documentation website.
As the project grows, a single folder of Markdown files can become harder for new users to navigate. I’d love to help set up a professional documentation site using MkDocs (with the Material theme).
Benefits of using MkDocs:
- Better navigation: Includes a searchable sidebar and table of contents for our existing .md files
- Searchability: Users can find specific functions or guides instantly through a built-in search bar
- Mobile friendly: The documentation would be easy to read on phones and tablets
- Low maintenance: It integrates directly with GitHub Pages and can update automatically whenever we push to main
I’ve already tested a local version using our current files. You can see a live demo of how it would look here: Docs
Let me know what you think! Happy to jump on a PR if this looks like a good direction for the repo.
I’ve been spending some time with the documentation in the /docs folder and noticed we have some great content that might be even more accessible if hosted as a dedicated documentation website.
As the project grows, a single folder of Markdown files can become harder for new users to navigate. I’d love to help set up a professional documentation site using MkDocs (with the Material theme).
Benefits of using MkDocs:
I’ve already tested a local version using our current files. You can see a live demo of how it would look here: Docs
Let me know what you think! Happy to jump on a PR if this looks like a good direction for the repo.