Conversation
- Inject JSON-LD schemas (Organization, SoftwareApplication, TechArticle, BreadcrumbList) and OG/Twitter Card meta tags into docs/theme/main.html - Create docs/robots.txt (AI crawler Allow rules, Disallow /0.*/, Sitemap) and docs/llms.txt (LLM-readable library summary, API index, citation) - Add CI step in publish-docs.yml to inject robots.txt and llms.txt into gh-pages branch root after each mike deploy - Add "What is Supervision?" definitional section and description frontmatter to docs/index.md; add description frontmatter to 13 how-to and reference pages --- Co-authored-by: Claude Code <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2224 +/- ##
=======================================
Coverage 77% 77%
=======================================
Files 66 66
Lines 8211 8211
=======================================
Hits 6350 6350
Misses 1861 1861 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances Supervision’s documentation discoverability by adding SEO/“GEO” metadata, LLM-friendly root files, and a publishing workflow step to place those root files on gh-pages.
Changes:
- Add JSON-LD structured data plus Open Graph/Twitter Card meta tags to the MkDocs theme.
- Introduce
robots.txtandllms.txt, and update the docs publish workflow to inject them into thegh-pagesroot. - Add per-page
descriptionfront matter across key docs pages and expand the homepage introduction.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/trackers.md |
Adds page description metadata for SEO snippets. |
docs/theme/main.html |
Injects JSON-LD + Open Graph/Twitter meta tags in the MkDocs theme. |
docs/robots.txt |
Adds crawler directives and a sitemap reference (see review comments). |
docs/llms.txt |
Adds LLM-oriented project summary, key APIs, and links. |
docs/index.md |
Adds homepage description and a “What is Supervision?” intro section. |
docs/how_to/track_objects.md |
Adds page description metadata. |
docs/how_to/save_detections.md |
Adds page description metadata. |
docs/how_to/process_datasets.md |
Adds page description metadata. |
docs/how_to/filter_detections.md |
Adds page description metadata. |
docs/how_to/detect_small_objects.md |
Adds page description metadata. |
docs/how_to/detect_and_annotate.md |
Adds page description metadata. |
docs/how_to/count_in_zone.md |
Adds front matter with description metadata. |
docs/how_to/benchmark_a_model.md |
Adds page description metadata. |
docs/detection/core.md |
Adds page description metadata. |
docs/detection/annotators.md |
Adds page description metadata. |
docs/datasets/core.md |
Adds page description metadata. |
docs/changelog.md |
Adds page description metadata. |
.github/workflows/publish-docs.yml |
Injects robots.txt and llms.txt into gh-pages root after deployment. |
- 404.html extends main.html; when MkDocs builds theme templates, page
context is None — page.title | tojson raises TypeError: Undefined is
not JSON serializable
- Wrap all JSON-LD and OG/Twitter blocks in {% if page %} so they are
skipped for theme templates; analytics scripts remain outside the guard
---
Co-authored-by: Claude Code <noreply@anthropic.com>
…agraphs - Add FAQPage JSON-LD (5 Q&As) on homepage for Google AIO extraction - Add Wikipedia to Organization sameAs for ChatGPT/Gemini entity graph - Add IndexNow key file + meta tag; CI pings Bing on every deploy - Fix release canonical: filter rc/alpha/beta tags from `latest` alias - Add 9 prose paragraphs after H2 headings across 6 how-to pages - Update site_description to accurate model-agnostic copy --- Co-authored-by: Claude Code <noreply@anthropic.com>
- /0.*/ block was misplaced after GoogleOther group (blank line ends a group in robots.txt), making it a dangling directive most parsers would ignore; move it into User-agent:* so all crawlers respect it [resolve #1] Review comment by @Copilot (PR #2224): "Disallow: /0.*/ directive is currently under the User-agent: GoogleOther group, so it only applies to that crawler..." --- Co-authored-by: Claude Code <noreply@anthropic.com>
Three files must stay in sync — add comments to the two that support comments (main.html, publish-docs.yml) so editors know not to rename or delete the key without updating all three locations. --- Co-authored-by: Claude Code <noreply@anthropic.com>
/0.*/ only covered 0.x releases; add /1.*/ through /9.*/ so future major versions are also disallowed — crawlers should index /latest/ only. robots.txt has no character classes, so one Disallow per leading digit. --- Co-authored-by: Claude Code <noreply@anthropic.com>
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 introduces major improvements to the documentation and publishing workflow for the Supervision library. The most significant updates include enhanced SEO and discoverability features, such as structured metadata, Open Graph and Twitter Card tags, and root files for search engines and LLMs. Additionally, the documentation content has been expanded with new descriptions and an improved introduction, and the publishing workflow now injects essential files into the
gh-pagesbranch.SEO and discoverability enhancements:
docs/theme/main.htmlfor improved SEO and social sharing.robots.txtto allow all major bots and provide a sitemap, and addedllms.txtwith a summary, install instructions, key APIs, and links for LLM discoverability. [1] [2].github/workflows/publish-docs.yml) to automatically injectrobots.txtandllms.txtinto thegh-pagesbranch on publish.Documentation content improvements:
descriptionmetadata to all major documentation pages for better search engine indexing and richer link previews. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]Homepage and introduction updates:
docs/index.md) with a concise library overview, key features, and community adoption metrics.These changes collectively make the documentation more discoverable, easier to understand for new users, and ready for integration with search engines and LLMs.