Skip to content

docs: regenrated the reference docs - #779

Closed
Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:update-reference
Closed

Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:update-reference

Conversation

@Iheanacho-ai

Copy link
Copy Markdown
Member

What

updated the reference docs.

Why

in keeping up with v1.14.1

Change

updated the makefile variable, TALOSCTL_IMAGE to 1.14.1 and ran make generate-talos-reference.

Testing

ran make preview and make validate-doc-nav

Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
@github-project-automation github-project-automation Bot moved this to To Do in Planning Sep 21, 2026
@talos-bot talos-bot moved this from To Do to In Review in Planning Sep 21, 2026
@github-actions

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 f9191a5 · 🔴 2 critical · 🟡 1 warning(s) · ⚪ 1 notice(s)

  • 🔴 public/talos/v1.14/reference/configuration/network/vxlanconfig.mdx:23 — VXLANConfig does not exist in Talos v1.14; this page documents a v1.15 feature under v1.14.
    • Why: pkg/machinery/config/types/network/vxlan.go exists only on the Talos main branch and 404s on release-1.14, and VXLAN link support is listed as new in v1.15.0-alpha.0. A v1.14 reader who copies this document gets the entire machine config apply rejected with an unknown document kind error.
    • Fix: Move this page to the Talos v1.15 reference tree and remove it from public/talos/v1.14/, or add an explicit 'available from Talos v1.15' note.
  • 🔴 public/talos/v1.14/reference/configuration/network/macvlanconfig.mdx:23 — MacVLANConfig does not exist in Talos v1.14; this page documents a v1.15 feature under v1.14.
    • Why: pkg/machinery/config/types/network/macvlan.go is absent from the release-1.14 branch and 404s at tag v1.14.1, existing only on main where MACVLAN support landed for v1.15. Applying this document on a v1.14 node fails config validation and takes the surrounding machine config with it.
    • Fix: Move this page to the Talos v1.15 reference tree and remove it from public/talos/v1.14/, or add an explicit 'available from Talos v1.15' note.
  • 🟡 public/talos/v1.14/reference/configuration/network/vxlanconfig.mdx:1 — The two new network pages are not listed in talos-v1.14.yaml and docs.json was not regenerated.
    • Why: talos-v1.14.yaml defines the Network group with an explicit pages list that omits macvlanconfig.mdx and vxlanconfig.mdx, and neither the YAML nor public/docs.json is in this change, so the pages are unreachable from navigation and the CI nav and docs.json checks will fail. Only .mdx files were provided for review, so disregard if those files were updated outside that list.
    • Fix: Add the two entries to the Network group in the version YAML and re-run make docs.json, committing the result, or remove the pages from the v1.14 tree.

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

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

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants