Skip to content

docs (talos hvm): add the Talos Hypervisor navigation structure - #805

Closed
Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:nav-bar-hvm
Closed

Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:nav-bar-hvm

Conversation

@Iheanacho-ai

Copy link
Copy Markdown
Member

What

Adds Talos Hypervisor as a product in the docs navigation: hypervisor.yaml with 11 pages across Overview, Getting Started, Storage, and Virtual Machines.

Why

This is the first of several Talos Hypervisor PRs for TalosCon. Putting the nav in one PR keeps each content PR from recreating it, and the combined PR at the end will bring all of them to main.

Change

  • hypervisor.yaml: new product (family hypervisor, tag "Open source", meta "Alpha · tracks Talos 1.15").
  • Makefile: adds hypervisor.yaml to docs.json, docs.json-local, check-missing, and check-missing-local.
  • common.yaml: removes the manual "coming soon" Talos Hypervisor card. The product now generates its own card, so keeping both would show it twice.
  • tools/frontmatter-check: requires title and description under public/hypervisor.
  • public/docs.json, public/index.mdx, public/script/product-nav.js: regenerated with make docs.json.

Testing

  • Ran: make docs.json, make validate-docs-nav, make check-frontmatter
  • Where: local checkout
  • By: an agent (Claude Code)
  • Result: docs.json regenerates cleanly and the frontmatter check passes. validate-docs-nav reports 11 "in yaml but file missing" errors, and broken-links is expected to flag the homepage card. Both are expected because the pages land in the follow-up PRs, and both clear in the combined PR.
  • Filled from outside the page: nothing

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

📋 Automated documentation review

An automated pass runs on documentation changes in every PR. The items below are suggestions to consider — advisory, not a merge gate.

Reviewed commit c215597 · 🔴 2 critical · 🟡 0 warning(s) · ⚪ 1 notice(s)

  • 🔴 public/index.mdx:67 — Homepage card links to /hypervisor/overview/what-is-talos-hypervisor, which does not exist in this repo.
    • Why: There is no public/hypervisor/ directory, no nav YAML declaring a hypervisor product, and no redirect for /hypervisor in common.yaml, so the card leads readers to a 404 and the required make broken-links CI check will fail. The PR adds no pages alongside the link.
    • Fix: Keep the card as soon: true until public/hypervisor/overview/what-is-talos-hypervisor.mdx and its nav file land in the same change.
  • 🔴 public/index.mdx:67 — public/index.mdx is generated from common.yaml; this hand edit is reverted by make docs.json and fails CI.
    • Why: tools/docs-gen writeHomepage rewrites public/index.mdx wholesale from the homepage block in common.yaml, which still declares the Talos Hypervisor card with soon: true and no href, so make docs.json restores the old markup and the CI step make docs.json && git diff --exit-code fails. The generator also suppresses the home-meta line on soon cards.
    • Fix: Edit common.yaml: on the Talos Hypervisor card drop soon: true and add href: "/hypervisor/overview/what-is-talos-hypervisor" and meta: "Alpha · tracks Talos 1.15", then run make docs.json and commit the regenerated index.mdx and docs.json.

Notices, and the reviewer's full report, are in the run's doc-accuracy-report artifact.

@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

📋 Automated documentation review

⚠️ The reviewer did not finish on commit 021a028 (it timed out or errored) — see the workflow run log. This run did not produce a result; any findings from an earlier run on this PR still stand.

Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
@github-project-automation github-project-automation Bot moved this from In Review to Approved in Planning Oct 13, 2026
@Iheanacho-ai
Iheanacho-ai marked this pull request as ready for review October 13, 2026 16:04
@sterlingkoch

Copy link
Copy Markdown
Member

Merged as part of #867.

@github-project-automation github-project-automation Bot moved this from Approved to Done in Planning Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants