diff --git a/docs/news/posts/new-user-docs-2026.md b/docs/news/posts/new-user-docs-2026.md index daa93e2..20e952b 100644 --- a/docs/news/posts/new-user-docs-2026.md +++ b/docs/news/posts/new-user-docs-2026.md @@ -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. diff --git a/docs/support/index.md b/docs/support/index.md index 99605d9..70044b3 100644 --- a/docs/support/index.md +++ b/docs/support/index.md @@ -9,10 +9,10 @@ There are several channels you can use to get support: * the **preferred** choice is to submit a ticket with [PSI Service Now](https://psi.service-now.com/psisp), alternatively -* you can also us our [user mailing list](#merlin-user-mailing-list), or lastly +* you can also us our [user mailing list](#merlin-user-mailing-list), or * you can email the Admins directly -!!! info +??? info Basic contact information is also displayed on every shell login to the system using the *Message of the Day* mechanism. diff --git a/mkdocs.yml b/mkdocs.yml index d9e56f2..b9433ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ site_url: https://hpce.pages.psi.ch repo_name: "User Documentation Repository" repo_url: https://gitea.psi.ch/hpce/gitea-pages # TODO unsure if this works, branch needs to be changed from `mkdocs` to `main` -edit_uri: _edit/mkdocs/docs/ +edit_uri: _edit/master/docs/ # Copyright copyright: Copyright © 2025 HPC and Emerging Technologies Group/CSD @ Paul Scherrer Institut