docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#69
Draft
rain-Brian wants to merge 1 commit into
Draft
docs: dedicated Getting Started page (own the onboarding query) + HowTo schema#69rain-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 SPARROW') to own the onboarding query. Since SPARROW is a hardware + software device, the page is a build-to-deploy HowTo: assemble hardware, flash and run one-click setup, bring up the Docker services, deploy in the field. Content is sourced from the existing index/hardware/setup pages and links out to them. - New page: docs/getting-started.md (HowTo JSON-LD gated per-page in overrides/main.html, alongside the existing WebSite/Organization graph) - index.md, hardware.md, setup.md: additive Getting Started pointers - mkdocs.yml: nav entry between Overview and Hardware Setup Verified: mkdocs build --strict exits 0 (with 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.
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 SPARROW", plus HowTo structured data. A dedicated-slug page is what wins the "getting started with X" query; SPARROW's onboarding was previously spread across the README, hardware, and setup pages.
What
docs/getting-started.mdat/SPARROW/getting-started/. Because SPARROW is a hardware + software device, the page is a genuine build-to-deploy HowTo: assemble hardware → flash + one-click setup → bring up the Docker services → deploy in the field. It links out to the existing Hardware Setup and Software Setup guides rather than restating them.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/hardware.md,docs/setup.md(additive): Getting Started pointers.mkdocs.yml: nav entry between Overview and Hardware Setup.All content is sourced from this repo's own 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; 4 inbound links to the pageOpened as a draft; not requesting review yet.