docs: drop mike version provider for pre-1.0#35
Merged
Conversation
mike maintains multiple versioned snapshots of the docs under one domain, with a version dropdown for switching between them. Useful once an API contract stabilizes and users on different installed versions need to read the docs that match their install. Pre-1.0, breaking changes are still expected — historical snapshots would just confuse readers (the API in v0.5 docs may not exist in v0.7). pydantic-ai's docs site (the polish reference) doesn't ship versioned docs either. Revisit when 1.0 ships and the API contract stabilizes. Removes ``extra.version.provider: mike`` from mkdocs.yml so Material's theme stops trying to fetch a versions.json that no CI step produces.
There was a problem hiding this comment.
Pull request overview
Removes the MkDocs Material versioning configuration (extra.version.provider: mike) that pointed to a non-existent version manifest, simplifying the docs configuration for the pre-1.0 phase.
Changes:
- Removed the
mikeversion provider block frommkdocs.ymlunderextra.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mike was the only consumer of ``version.provider: mike`` in mkdocs.yml, which the previous commit removed. Drop the ``mike>=2.1,<3`` line from pyproject.toml's docs group and regen uv.lock so the docs install surface no longer pulls in mike + its transitives (pyparsing, verspec).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Removes the
extra.version.provider: mikeline (and its comment block) frommkdocs.yml. Material's theme was configured to look for aversions.jsonfile that no CI step actually produces, so this just cleans up a setting that pointed nowhere.Why
mike maintains multiple versioned snapshots of the docs under one domain, with a version dropdown for switching between them. Useful once an API contract stabilizes and users on different installed versions need to read the docs that match their install.
Pre-1.0, breaking changes are still expected — historical snapshots would just confuse readers (the API in v0.5 docs may not exist in v0.7). pydantic-ai's docs site (the polish reference we've been targeting) doesn't ship versioned docs either. Revisit when v1.0 ships and the API contract stabilizes.
Test plan
uv run mkdocs build --strict— clean.Docsworkflow on this PR builds the site withmkdocs build --strict.