docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#11
Draft
rain-Brian wants to merge 1 commit into
Draft
docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#11rain-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 'getting started with MegaDetector-Acoustic') to own the onboarding query. The page is an install -> prepare audio -> train -> infer HowTo, sourced from the existing Overview and Installation pages and linking out to them and the demo notebook. - New page: docs/getting-started.md (HowTo JSON-LD gated per-page in overrides/main.html, alongside the existing WebSite/Organization graph) - index.md, installation.md: additive Getting Started pointers - mkdocs.yml: nav entry between Overview and Installation Verified: mkdocs build --strict exits 0 on the repo's tracked docs; HowTo renders only on the getting-started page (4 HowToStep); new URL in sitemap; 0 em-dashes; ai_tells clean. Live checks (Lighthouse, indexing) deferred until the repo goes public.
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 MegaDetector-Acoustic", plus HowTo structured data. A dedicated-slug page is what wins the "getting started with X" query.
What
docs/getting-started.mdat/MegaDetector-Acoustic/getting-started/. An install → prepare audio → train → run-inference HowTo, sourced from the existing Overview and Installation pages and linking out to them and the demo notebook.overrides/main.html: aHowToJSON-LD block, gated per-page (samesrc_pathmechanism as the existing WebSite/Organization graph) so it renders only on the new page.docs/index.md,docs/installation.md(additive): Getting Started pointers.mkdocs.yml: nav entry between Overview and Installation.Content sourced only from this repo's own committed docs; nothing external copied.
Verification
mkdocs build --strictexits 0 on the repo's tracked docsHowTo(4HowToStep) renders only on the getting-started page, 0 on the homepagesitemap.xml; 0 em-dashes; AI-tells linter cleanLive checks deferred: the repo is private with Pages stuck on a randomized URL, so Lighthouse, live-sitemap, and indexing checks are deferred until go-public.
Opened as a draft; not requesting review yet.