docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#31
Draft
rain-Brian wants to merge 1 commit into
Draft
docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#31rain-Brian wants to merge 1 commit into
rain-Brian wants to merge 1 commit into
Conversation
Add docs/getting-started.md at its own URL (slug + title + H1 matching the 'getting started with MegaDetector' query) to own the onboarding intent that the homepage does not title-match. The page is hub-and-spoke: it presents the decide / pick-a-path / first-run / read-output / scale-up sequence and links out to the deeper reference pages rather than restating them. All content is sourced from existing repo docs. - New page: docs/getting-started.md (HowTo JSON-LD, gated per-page in overrides/main.html alongside the existing WebSite/FAQPage blocks) - index.md: add a Getting Started pointer (additive; quick-start kept) - faq.md: add 'How do I get started with MegaDetector?' question - overrides/main.html: HowTo block + new FAQPage entry mirroring faq.md - mkdocs.yml: nav entry between Overview and Installation Verified: mkdocs build --strict exits 0; HowTo renders only on the getting-started page (4 HowToStep); new URL in sitemap; 0 em-dashes; ai_tells clean for the new page.
This was referenced Jun 24, 2026
Draft
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
External getting-started gateways (a WILDLABS Tech Tutors page and Dan Morris's readthedocs
getting-started.html) currently win the "getting started with MegaDetector" / "how do I get started with MegaDetector" query. They win structurally: the query string matches their page slug, title, and H1 at once, on a dedicated URL. Our onboarding content was strong but embedded inside the homepage, and a generic homepage URL loses that query to a dedicated-slug page.This adds a dedicated Getting Started page to close that gap. The work is additive: nothing is removed from the homepage or other pages.
What
docs/getting-started.mdat/MegaDetector/getting-started/with slug + title + H1 all matching the target query. Hub-and-spoke: it walks decide-if-it-fits → pick-a-path → first small batch → read-output → scale-up, linking out to Installation, CLI, Output Format, Model Zoo, FAQ rather than restating them.overrides/main.html: aHowToJSON-LD block, gated per-page (samesrc_pathmechanism as the existing WebSite/FAQPage blocks) so it renders only on the new page. Added the new FAQ Q&A to the existingFAQPagegraph so schema stays in sync withfaq.md.docs/index.md(additive): a Getting Started pointer near the top; the Quick start section is unchanged.docs/faq.md(additive): new question "How do I get started with MegaDetector?".mkdocs.yml: nav entry between Overview and Installation.All page content is sourced from existing repo docs; no external/reference content was copied.
Verification
mkdocs build --strictexits 0HowTorenders only on the getting-started page (4HowToStep), 0 on the homepagefaq/index.html; new URL present insitemap.xml