Skip to content

docs: add the Talos Containers navigation structure - #887

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

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

Conversation

@Iheanacho-ai

@Iheanacho-ai Iheanacho-ai commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

What

Adds the Talos Containers navigation and makes the product reachable from the product switcher and the homepage.

Why

Talos Containers is documented inside the versioned Talos Linux docs, so it has no navigation of its own and no way into the product switcher.

Change

  • Adds a "Talos Containers" group to talos-v1.14.yaml and talos-v1.15.yaml, after "Configure your Talos cluster".
  • Adds talos-containers.yaml, which declares Talos Containers as a linked product pointing at How Talos Containers Work.
  • Adds an href field to products in tools/docs-gen. A product with an href renders as a link in the product switcher, and its homepage card points at the same href. A linked product is left out of product-nav.js, where its URL segment would overwrite the entry of the product it links into.
  • Removes the hand-written Talos Containers card from common.yaml, since the card now comes from the product file.
  • Regenerates docs.json and index.mdx.

The pages land in separate PRs, so validate-docs-nav and broken-links fail on this branch alone until they are combined.

Part of #881

Testing

  • Ran: go vet and go test in tools/docs-gen, make docs.json-local, check-missing-local, canonical-links-check, and validate-docs-nav on this branch and on the combined branch.
  • Result: tests pass and docs.json is current. On the combined branch, the only nav failure is the storage page from Talos Containers docs: Give a container storage and configuration files #884, which is not written yet.

@mintlify

mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 14f8c11.

Approve preview

@github-project-automation github-project-automation Bot moved this to To Do in Planning Oct 26, 2026
@Iheanacho-ai
Iheanacho-ai force-pushed the nav-bar-containers branch 2 times, most recently from 9e614ee to f2ae5b3 Compare October 26, 2026 15:33
@talos-bot talos-bot moved this from To Do to In Review in Planning Oct 26, 2026
@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

📋 Automated documentation review

⚠️ The reviewer did not finish on commit 14f8c11 (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.

@smira smira removed this from Planning Oct 27, 2026
@sterlingkoch

Copy link
Copy Markdown
Member

880 merged, so this conflicts now. Talos Containers moved under Operating system in common.yaml with docsSoon: true. After the rebase, put the href on that card and drop docsSoon. Then make docs.json for index.mdx and docs.json.

Also: the description says the group goes after "Deploying and managing workloads," but it's after "Configure your Talos cluster." I'd put it after workloads, same in both versions.

Add a "Talos Containers" group to the v1.14 and v1.15 navigation, after
"Configure your Talos cluster".

Add Talos Containers to the product switcher and the docs homepage as a
link into that group. The pages live inside the Talos Linux versions, so
the product has no navigation of its own: the generator gains an `href`
field for such linked products, which Mintlify renders as a link in the
switcher. A linked product is left out of product-nav.js, where its url
segment would overwrite the entry of the product it links into.

The pages themselves land in separate pull requests, so the nav check
fails until they are combined with this branch.

Part of siderolabs#881

Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
@Iheanacho-ai
Iheanacho-ai marked this pull request as draft October 29, 2026 08:55

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants