docs: improve SEO and GEO docs publishing#2232
Merged
Merged
Conversation
Align docs deployment with develop, release/latest, and tag-only release paths. Add trust pages, expanded schema, AI crawler artifacts, and root GEO file publishing. Co-authored-by: Codex <codex@openai.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2232 +/- ##
=======================================
Coverage 78% 78%
=======================================
Files 66 66
Lines 8345 8345
=======================================
Hits 6473 6473
Misses 1872 1872 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Supervision’s documentation site content and publishing infrastructure to improve SEO/GEO metadata, add trust/contact pages, and enhance crawler support across versioned docs deployments.
Changes:
- Add new docs pages (About, Contact, FAQ) and surface them in MkDocs navigation.
- Expand SEO/GEO metadata in the MkDocs theme (JSON-LD, OpenGraph/Twitter tags) and introduce AI-crawler summary content (
llms-100k.txt). - Update the docs publishing workflow to deploy
/latest/fromrelease/latestand sync additional root files (including_headers) intogh-pages.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updates site description and adds About/Contact/FAQ to nav. |
| docs/theme/main.html | Adds/adjusts JSON-LD schemas and OG/Twitter meta tags for richer indexing. |
| docs/theme/cookbooks.html | Updates cookbook links to be version-relative instead of hard-coded to /develop/. |
| docs/robots.txt | Simplifies crawl rules and explicitly allows Applebot. |
| docs/llms-100k.txt | Adds a large-context AI crawler summary with key docs/API links. |
| docs/faq.md | Adds a new FAQ page with installation and usage answers. |
| docs/contact.md | Adds a new Contact page with support/security guidance. |
| docs/about.md | Adds a new About page describing the project and links. |
| docs/_headers | Adds hosting security headers including CSP and HSTS. |
| .github/workflows/publish-docs.yml | Extends deployment logic to handle release/latest, tag-only releases, and extra root file injection. |
- Clarify model compatibility by listing explicit supported frameworks and converters. - Simplify asset handling instructions, highlighting inclusion in base package. - Standardize descriptions of `Detections` and `KeyPoints` converters for consistent messaging.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
[resolve #1] Review comment by @Copilot (PR #2232): "The cookbook card title has a spelling error (\"Underestand\"). This is user-facing text and will be indexed/visible in the docs UI; please correct the display name while keeping the existing slug if that path is intentional." - Fixed heading in docs/notebooks/underestand-visitors-with-yolo-world.ipynb - Slug/filename preserved as Copilot instructed --- Co-authored-by: Claude Code <noreply@anthropic.com>
[resolve #4] Review comment by @Copilot (PR #2232): "The JSON-LD SearchAction target is hard-coded to the /latest/ search path. On /develop/ or tag builds, this points to a different version..." - Replace hard-coded /latest/search/ with {{ config.site_url }}search/ - Now resolves correctly for each deployed version --- Co-authored-by: Claude Code <noreply@anthropic.com>
--- Co-authored-by: Claude Code <noreply@anthropic.com>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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.
This pull request updates the documentation site infrastructure and content for the Supervision project. It enhances the publishing workflow, adds new documentation and metadata files, improves security headers, and expands support for AI crawlers. The most important changes are grouped below:
Documentation Content Additions:
about.md,contact.md, andfaq.md, providing project overview, contact/support channels, and frequently asked questions for Supervision. [1] [2] [3]llms-100k.txt, a large-context summary file for AI crawlers with detailed project, API, and reference links.Publishing Workflow Improvements:
.github/workflows/publish-docs.ymlto support deploying documentation for therelease/latestbranch, add new root files, and streamline release/tag deployments. [1] [2] [3]Security and Metadata Enhancements:
_headersfile with strict security headers for documentation hosting, including HSTS, CSP, and others.AI and Crawler Support:
robots.txtto remove numeric version path blocks and explicitly allow Applebot, expanding AI crawler access. [1] [2]