final changes

This commit is contained in:
2026-01-12 17:43:20 +01:00
parent 8100c03090
commit b7107b9210
2 changed files with 13 additions and 8 deletions

View File

@@ -3,20 +3,25 @@ date:
created: 2026-01-12
tags:
- getting_started
- draft
---
# New User Documentation Site
Starting in 2026, we are changing the design of the user documentation website.
Previously we had used the [documentation
theme](https://github.com/tomjoht/documentation-theme-jekyll) together with the
[Jykell SSG](https://jekyllrb.com/), but have now switch to the more modern
Previously we had used the theme [Documentation for
Jekyll](https://github.com/tomjoht/documentation-theme-jekyll) together with
the [Jykell SSG](https://jekyllrb.com/), but have now switch to the more modern
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme and
SSG engine. This comes with a few improvements:
* searching is more complete and provides better results
* theme related improvements (day-night coloring, page layout, content formatting)
* edits for pages can be submitted via the *Edit* (this will direct you to the Gitea repository which hosts the documentation)
* edits for pages can be submitted via the *Edit* button (taking you to the
Gitea editor and letting you submit a pull request)
TBD
With the latter new feature, we encourage our users to point out any issues they
find with the documentation. Contributation are very welcome and will help in
ensuring that the documentation is kept up-to-date.
Notice also that we now have a dedicated [Support](../../support/index.md) page,
making it easier to find and use our different contact options.