New Cloudron Docs Framework - Requesting feedback
-
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:
-
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 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?
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
npmoryarnis needed and a little knowledge with Markdown. -
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.
-
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.
-
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:
-
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:
-
Feature - Persistent check boxes
In the docs.cloudron.io and docs-ng.cloudron.io we added a feature that checkbox items will persist.
Meaning, if you follow a documentation / guide that has checkboxes, you can actually check them to keep track of what you are doing.
The state of a checkbox is stored in the browser local storage, but the state is volatile.
If you clear your browser cache (or just for the doc pages) the checkbox state is lost.For docs-ng.cloudron.io it looks like this:
For docs.cloudron.io it looks like this:
-
Hello Community
Update on https://docs-ng.cloudron.io/
The search is now scoped to docs and API.
If the search is used in the docs, only the docs are returned.
If the search is used in the API, only the API is returned.We would greatly appreciate some extra eyes looking over https://docs-ng.cloudron.io/ to give feedback if anything is missing, broken, too different from the old docs and so on.
-
Quick look. Don't know if that's intended but the "Next" button at the bottom of a page does not link to the next category (though the "Previous" button goes back one category).
