chore: move documentation from docosaurus to mkdocs#435
chore: move documentation from docosaurus to mkdocs#435
Conversation
RokasBliu
force-pushed
the
chore/move-docs-from-docosaurus-to-mkdocs
branch
from
3703265 to
57e3755
Compare
RokasBliu
force-pushed
the
chore/move-docs-from-docosaurus-to-mkdocs
branch
from
97669f1 to
d8b1178
Compare
einarwar
left a comment
einarwar
left a comment
There was a problem hiding this comment.
This looks really nice! Tested it locally by running uv run zensical serve and they seem to render nicely
There was a problem hiding this comment.
Suggestion: I think having this pyproject.toml and corresponding uv.lock thats related to the docs is kinda out of place in the repo root.
Does it break anything if we move it inside the docs directory?
If we do that, the GHA workflows also needs to be updated to point to the correct directory
There was a problem hiding this comment.
Suggestion: Not really related to this file, but here goes.
Would be nice with a small mention somewhere in the readme on how to build and view docs locally
| uv sync --group docs | ||
| source .venv/bin/activate | ||
| zensical build |
There was a problem hiding this comment.
I think this can be changed to:
| uv sync --group docs | |
| source .venv/bin/activate | |
| zensical build | |
| uv sync --group docs --locked | |
| uv run zensical build |
There was a problem hiding this comment.
I think the pyproject.toml related to docs should also be added here
2 participants
Why is this pull request needed?
Many dependabot updates on Docosaurus documentation, so it's about time to move the documentation to mkdocs. This way it will also be possible to add the documentation to Varia.
What does this pull request change?
Moves everything from
/documentation(Docosaurus) to/docs(mkdocs).