Website Prototype Proposal: HotDoc
In Bastian last blog post you seem to have made the choice that the new website will be using Django and be dynamic. I have no strong opinion but could't find any discussion about why you made that choice. I would like that discussion to be public if possible :-)
I also wanted to be sure that you know that in 2016 we actually started porting the gnome-devel-docs "Design guidelines" part to hotdoc. I just brought that back to modern hotdoc (too modern as it relies on a branch that we haven't merged yet but that should be doable quickly if required), the port result is hosted on my gitlab pages you can see the result here:
Test instance
- https://thiblahute.pages.gitlab.gnome.org/gnome-devel-docs/index.html
- https://thiblahute.pages.gitlab.gnome.org/gnome-devel-docs/programming-guidelines.html
Also note that I ported all GStreamer documentation to hotdoc: https://thiblahute.github.io/GStreamer-doc/ this need finalizing but it is pretty much done already :-) (I changed employer so changed focus sadly).
Notable Features
- Generates a full static website which can become the Developer Center, including API reference.
- Programming Languages are linked together so you can easily switch from one programming language to another.
- Meant as a replacement for GtkDoc and compiles much faster.
- Documentation is written in Markdown.
- Editable through "Edit in Gitlab" links.
Challenges
- The project has not been developed further so much lately since there are not so many users and the current users of HotDoc have most of the features they want.
- Existing Mallard documentation would need to be ported to MarkDown. @mathieudu implemented a PanDoc reader which could be usable for this purpose.
- Libraries would need to be ported from GtkDoc to HotDoc.