Standardize per-machine hierarchy of sidebar sections/directory names/etc; automatically enforce a limit on max depth of sidebar hierarchy #556
Labels
maintenance
Preserving quality source code and tools for docs authors (via GitHub Actions, CLI utilities, etc.)
organization
where to place/split/replicate .md content; nav menu dropdown and folder hierarchy
style
subjective design choices, language conventions, how and when to use mkdocs & theme features
{Polaris, Sophia, Aurora, Crux} wont have a complete overlap of documentation pages, but where they do, the directories and navigation sidebar titles should be named identically. Polaris is probably our currently closest superset:
As seen in #554, renaming a directory after a significant amount of content has been added has the potential to be quite painful. It breaks all the relative links from
.md
files that are not children of that directory, plus other absolute links like extensions such as Snippets demands:@FilippoSimini also pointed out that the current sidebar has way too many levels:

We could limit the max depth to 3 or so. Should probably revisit this after the significant style redesign in #545 is merged. Bolded "section headers" that don't increase the indentation or require clicking a dropdown arrow can help categorize things too.
The text was updated successfully, but these errors were encountered: