docs: bootstrap quick guide + wide findability pass - #21
Merged
Conversation
Add get-started/bootstrap for custom setup until ready (VM + agent + bootstrap with zero failures), keep the readiness protocol as the deep dive, and make the rest of the docs easier to land on: - descriptive titles and search keywords across guides/explain/MCP/reference - "If you only need…" shortcode pointing short paths at get-started - search ranks titles/keywords higher and surfaces section chips - relative in-tree links (no more hardcoded /docs/0.2.2/ on main) - publish updated tree to 0.4.0; stub bootstrap pages on 0.2.2/0.3.0 so nav works
|
Coverage (lines): commit Coverage report by file (80% overall — click to expand)
|
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.
Summary
Makes grain docs easier to use for people who both author custom images/bootstrap and consume sandboxes (same person today):
/get-started/bootstrap/walkthrough: ready = VM up + agent healthy + bootstrap finished with zero failures, cloud-init sample,grain-ready-report,status/health. Full contract stays on Readiness protocol.keywordsfor search, better ranking (title/keywords/section), search placeholder/empty-state hints, section chips in results./docs/0.2.2/paths onmainwith relative in-tree links so versioned trees stay correct.main; thin bootstrap stubs on 0.2.2 / 0.3.0 so the shared nav item does not 404.Nav: Learn → Bootstrap until ready.
Test plan
hugo --minifyindocs/(213 pages)/docs/0.4.0/get-started/bootstrap/and only-need boxes on agent / readiness / MCPbootstrap,MCP,act— expect get-started / MCP hits near top with keywords