New Cloudron Docs Framework - Requesting feedback

[james]

Hello Cloudron Community

Currently, the Cloudron Docs at docs.cloudron.io are build with mkdocs and mkdocs-material.
Unfortunately mkdocs-material is now in maintenance mode which means we have to look for alternatives.

We have looked into Docusaurus and migrated the documentation and would appreciate some feedback from the community.

Here is the URL: https://docs-ng.cloudron.io/

---

My personal favourite is the new API Doc which has an interactive component to test the API.
Example: https://docs-ng.cloudron.io/api/list-apps-by-user you can edit the URL and your token and actually use the API:

[jdaviescoates]

@james first question: presumably you looked at Zensical https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/ and ruled it out for some reason?

[mononym]

Docusaurus looks promising to me. I have a remark related to who you expect to contribute. I often see that the learning curve to contribute to docs build as a static site is too steep for non-techies. They have a difficult time when there's no CMS. That is also the reason I posted once about the Kalmia project. The real problem is that the documentation is actually a very good place for non-techies to contribute. I sometimes feel like it needs more skills to build the documentation than the project itself.

[james]

Hello @jdaviescoates

@jdaviescoates said in New Cloudron Docs Framework - Requesting feedback:

presumably you looked at Zensical

Yes we have looked at Zensical.
Zensical is still early in development and subjected to a lot of change.
We need to consider stability, longevity and support, since we have to maintain it.

@mononym said in New Cloudron Docs Framework - Requesting feedback:

I have a remark related to who you expect to contribute.

For contributing to the doc with Docusaurus only npm or yarn is needed and a little knowledge with Markdown.

[humptydumpty]

Looks great and very lightweight. BUT, search isn't working for me. I typed "migrating" and it just spins forever. It was flawless on the old app and showed the result(s) in the dropdown almost immediately. This is on PC/Firefox.

[james]

Hello @humptydumpty
Thanks for reporting. It used to work. We will look into it.

Edit:
Found the problem, fix is beeing deployed.