docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#20
Draft
rain-Brian wants to merge 1 commit into
Draft
docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#20rain-Brian wants to merge 1 commit into
rain-Brian wants to merge 1 commit into
Conversation
Stacks on the PyTorch-Wildlife docs SEO work (this branch is based on seo/pw-api-docs). Adds docs/getting-started.md at its own URL (slug + title + H1 matching 'getting started with PyTorch-Wildlife') to own the onboarding query, following the MegaDetector pattern (microsoft/MegaDetector#31). - New page: docs/getting-started.md (install -> first detection -> add classification -> scale up), sourced from existing docs and linking out - overrides/main.html: HowTo JSON-LD gated per-page (src_path) - index.md, installation.md, inference-examples.md: additive pointers - mkdocs.yml: nav entry between Overview and Installation HowTo renders only on the getting-started page (4 HowToStep); 0 em-dashes; ai_tells clean. Pre-existing base-branch griffe warnings (lmds.py docstrings) are unrelated to this change.
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
1 participant
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.
Why
Replicates the pattern shipped for MegaDetector (microsoft/MegaDetector#31): a dedicated getting-started page at its own URL, with slug + title + H1 all matching "getting started with PyTorch-Wildlife", plus HowTo structured data. A dedicated-slug page is what wins the "getting started with X" query.
Stacked PR
This stacks on #18 (
seo/pw-api-docs), which carries the docs SEO foundation (overrides +custom_dir,inference-examples.md,api.md,model_zoo.md) that this page depends on. The PW SEO branches merge in order #15 → #16 → #18 → this. The diff here is only the getting-started addition. Retarget tomainonce the chain lands.What
docs/getting-started.mdat/Pytorch-Wildlife/getting-started/: install → first detection → add classification → scale up, linking out to Installation, Inference Examples, API, and Model Zoo rather than restating them.overrides/main.html: aHowToJSON-LD block, gated per-page (src_path) so it renders only on the new page.docs/index.md,docs/installation.md,docs/inference-examples.md(additive): Getting Started pointers.mkdocs.yml: nav entry between Overview and Installation.Content sourced from this repo's own docs; nothing external copied.
Verification
HowTo(4HowToStep) renders only on the getting-started page, 0 on the homepage; new URL insitemap.xmlmkdocs build --strictaborts on pre-existing base-branchgriffewarnings inlmds.py(API autodoc), unrelated to this change. This page itself adds no new warnings.Opened as a draft; not requesting review yet.