refactor(docs): port entire documentation from mkdocs to hugo #1899
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗒️ Description
To make maintaining docs easier and faster I think we should port them to hugo. This PR would be followed up with another PR to cut the then unneeded dependencies which makes future uv lock upgrades much less painful:
What works already
I did most of the porting already
Note: I have not yet fixed all instances of the above things we can do, but I am working on it as we speak. It is a fairly fast process as we merely have to replace old syntax with new syntax.
What still needs to be fixed
How to see the current status of ported docs
Download latest hugo binary, cherry-pick this PR, navigate into docs folder and run
hugo server
🔗 Related Issues or PRs
N/A.
✅ Checklist
tox
checks to avoid unnecessary CI fails, see also Code Standards and Enabling Pre-commit Checks:uvx --with=tox-uv tox -e lint,typecheck,spellcheck,markdownlint
type(scope):
.mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.@ported_from
marker.