Skip to content

Switch to MkDocs and hosted documentation #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jul 2, 2025
Merged

Switch to MkDocs and hosted documentation #744

merged 11 commits into from
Jul 2, 2025

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Jul 1, 2025

This is a tracking branch for moving from GitHub markdown documentation to MkDocs and hosted documentation on docs.astral.sh.

It includes the following changes:

And some to-do tasks are:

Post-merge to-do tasks:

  • Consider writing guides for core workflows
  • Consider using pre-commit instead of the prettier format command (adapt CONTRIBUTING.md)

The following changes are part of this task but can be merged to main prior to this feature:

zanieb and others added 10 commits July 1, 2025 14:14
Extends #730, separated so we can test publishing the documentation
manually before doing so on release.

This is copied from ruff.
This copies the documentation scaffolding from uv, doing the minimum
amount of work to make it viable.

---------

Co-authored-by: David Peter <[email protected]>
This needs to be the Astral icon since all of the documentation pages
are on the same subdomain
<img width="471" alt="Screenshot 2025-07-01 at 12 01 07 PM"
src="https://github.com/user-attachments/assets/404eaeaa-9d8a-4307-82c4-d9757d4d7f43"
/>

This renders up in the top left
To ensure things are working! The `--strict` flag performs checks for
valid URLs and such.
Splits each top-level heading of the existing documentation into
a dedicated page as a starting point.

---------

Co-authored-by: David Peter <[email protected]>
@sharkdp sharkdp marked this pull request as ready for review July 2, 2025 14:33
@zanieb zanieb merged commit f867272 into main Jul 2, 2025
12 checks passed
@zanieb zanieb deleted the feat/docs branch July 2, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants