Skip to content
Snippets Groups Projects
Commit a2eccaea authored by Martin Schroschk's avatar Martin Schroschk
Browse files

Document preserving pages

parent 8005192b
No related branches found
No related tags found
2 merge requests!661Automated merge from preview to main,!657Document preserving pages
...@@ -105,6 +105,13 @@ documentation page, i. e. `shortened_page_heading.md`. ...@@ -105,6 +105,13 @@ documentation page, i. e. `shortened_page_heading.md`.
Make sure that the new page **is not floating**, i.e., it can be reached directly from Make sure that the new page **is not floating**, i.e., it can be reached directly from
the documentation structure. the documentation structure.
#### Preserve URLs
For several reasons it is important to preserve URLs within this documentation, e.g., pages with
description of specific hardware might be used as references in papers. Therefore, existing pages
shall not be renamed oder moved on directory level. Outdated pages are marked with "Outdated" tag
and moved to the archive by changing the page's navigation entry in the `mkdocs.yaml` file.
### Markdown ### Markdown
All documentation is written in Markdown. Please keep things simple, i.e., avoid using fancy All documentation is written in Markdown. Please keep things simple, i.e., avoid using fancy
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment