[GH-ISSUE #2] Finetuning the docs #1

New issue

Closed

opened 2026-03-23 20:37:32 +00:00 by mirror · 1 comment

mirror commented

2026-03-23 20:37:32 +00:00

Owner

Originally created by @bbilly1 on GitHub (Mar 21, 2023).
Original GitHub issue: https://github.com/tubearchivist/docs/issues/2

Excellent work on this by @jonasrosland, this makes our docs much more professional.

A few notes of improvements:

Annotations require an additional package, same functionality is also provided by Admonitions making development and deployment easier by reducing complexity.
This loads google fonts automatically, deactivate them and substitute by our own locally loaded fontface definition.
Move installation instructions to a top level nav point and split platform specific instructions to sub pages.
Apply custom CSS to match with TA color scheme.

After that:

Build and deploy, setup triggers to rebuild docs on merge on master.

Originally created by @bbilly1 on GitHub (Mar 21, 2023). Original GitHub issue: https://github.com/tubearchivist/docs/issues/2 Excellent work on this by @jonasrosland, this makes our docs much more professional. A few notes of improvements: - [x] Annotations require an additional package, same functionality is also provided by [Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) making development and deployment easier by reducing complexity. - [X] This loads google fonts automatically, deactivate them and substitute by our own locally loaded fontface definition. - [X] Move installation instructions to a top level nav point and split platform specific instructions to sub pages. - [X] Apply custom CSS to match with TA color scheme. After that: - [X] Build and deploy, setup triggers to rebuild docs on merge on master.