Skip to content

Remove mike dependency from documentation configuration#2051

Closed
Copilot wants to merge 2 commits intoci/build-docsfrom
copilot/sub-pr-2038
Closed

Remove mike dependency from documentation configuration#2051
Copilot wants to merge 2 commits intoci/build-docsfrom
copilot/sub-pr-2038

Conversation

Copy link
Contributor

Copilot AI commented Jan 7, 2026

The deployment strategy changed from mike deploy to peaceiris/actions-gh-pages, making the mike version provider configuration obsolete.

Changes:

  • Removed version.provider: mike from mkdocs.yml extra configuration
  • Removed mike>=2.0.0 from pyproject.toml docs dependencies

The documentation build now works without mike, aligning with the GitHub Actions-based deployment approach.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: Borda <6035284+Borda@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 7, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • astral.sh
    • Triggering command: /usr/bin/curl curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Update mkdocs.yml to remove reliance on mike Remove mike dependency from documentation configuration Jan 7, 2026
Copilot AI requested a review from Borda January 7, 2026 16:27
@Borda
Copy link
Member

Borda commented Jan 7, 2026

@copilot, so with this drop, how is the version set? Explain it and justify the change by referring to relevant sources or examples.

Copy link
Contributor Author

Copilot AI commented Jan 7, 2026

@copilot, so with this drop, how is the version set? Explain it and justify the change by referring to relevant sources or examples.

With mike removed, versioning is now handled through directory-based deployment using GitHub Actions:

How it works:

  • The peaceiris/actions-gh-pages action deploys to specific subdirectories in the gh-pages branch
  • Development docs deploy to /develop directory (from develop branch pushes)
  • Release docs deploy to /[tag_name] directory (from release events, e.g., /0.27.0)
  • The destination_dir parameter in the workflow controls where each build is placed

Key differences from mike:

  • No version selector UI - mike provided a version dropdown widget in the docs, which is now removed
  • No version aliases - mike managed aliases like "latest" → "0.27.0"; now users navigate directly to version-specific URLs
  • Simpler deployment - Standard mkdocs build outputs to site/, which is pushed to the appropriate directory
  • Direct URL access - Users visit https://supervision.roboflow.com/develop/ or https://supervision.roboflow.com/0.27.0/ directly

References:

  • peaceiris/actions-gh-pages destination_dir - Documents subdirectory deployment
  • Current gh-pages structure shows ~50 version directories (0.10.0 through 0.27.0) plus develop
  • This approach is used by many projects deploying multiple doc versions without a version manager (e.g., static sites with manual version links)

The tradeoff is simplicity vs. convenience: no dependency on mike's version management, but also no automatic version switching UI.

@Borda Borda marked this pull request as ready for review January 8, 2026 10:41
@Borda Borda requested a review from SkalskiP as a code owner January 8, 2026 10:41
Copilot AI review requested due to automatic review settings January 8, 2026 10:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes the mike dependency from the documentation configuration, as the deployment strategy has transitioned from using mike deploy to GitHub Actions with peaceiris/actions-gh-pages.

Key Changes:

  • Removed mike version provider configuration from mkdocs.yml
  • Removed mike>=2.0.0 from documentation dependencies in pyproject.toml

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
mkdocs.yml Removed the version.provider: mike configuration from the extra section
pyproject.toml Removed mike>=2.0.0 from the docs dependency group

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Borda
Copy link
Member

Borda commented Jan 8, 2026

Based on the "Key differences from mike" we need to keep mike

@Borda Borda closed this Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants