Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions docs/talos/reference/cli/sidebar.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// Hand-maintained navigation tree for the auto-generated Talos CLI reference.
//
// The CLI docs (talos-*.md in this directory) are generated from Cobra and ship
// without a sidebar, so this file mirrors the `talos --help` command hierarchy.
// When commands are added/removed, update this tree to match the generated pages.
//
// Imported by sidebars-oss.ts and sidebars-oel.ts and rendered as the
// "CLI reference" category (linked to the root `talos` command page).
const id = (name: string) => `talos/reference/cli/${name}`

const talosCliReference = {
type: "category",
label: "CLI reference",
link: { type: "doc", id: id("talos") },
items: [
{
type: "category",
label: "talos jwk",
link: { type: "doc", id: id("talos-jwk") },
items: [
{
type: "category",
label: "talos jwk generate",
link: { type: "doc", id: id("talos-jwk-generate") },
items: [
id("talos-jwk-generate-ecdsa"),
id("talos-jwk-generate-eddsa"),
id("talos-jwk-generate-hmac"),
id("talos-jwk-generate-rsa"),
],
},
id("talos-jwk-get"),
],
},
{
type: "category",
label: "talos keys",
link: { type: "doc", id: id("talos-keys") },
items: [
id("talos-keys-issue"),
id("talos-keys-verify"),
id("talos-keys-batch-verify"),
id("talos-keys-derive-token"),
id("talos-keys-self-revoke"),
{
type: "category",
label: "talos keys issued",
link: { type: "doc", id: id("talos-keys-issued") },
items: [
id("talos-keys-issued-issue"),
id("talos-keys-issued-get"),
id("talos-keys-issued-list"),
id("talos-keys-issued-update"),
id("talos-keys-issued-rotate"),
id("talos-keys-issued-revoke"),
],
},
{
type: "category",
label: "talos keys imported",
link: { type: "doc", id: id("talos-keys-imported") },
items: [
id("talos-keys-imported-import"),
id("talos-keys-imported-batch-import"),
id("talos-keys-imported-get"),
id("talos-keys-imported-list"),
id("talos-keys-imported-update"),
id("talos-keys-imported-revoke"),
id("talos-keys-imported-delete"),
],
},
],
},
{
type: "category",
label: "talos migrate",
link: { type: "doc", id: id("talos-migrate") },
items: [
id("talos-migrate-up"),
id("talos-migrate-down"),
id("talos-migrate-status"),
id("talos-migrate-force"),
],
},
id("talos-proxy"),
{
type: "category",
label: "talos serve",
link: { type: "doc", id: id("talos-serve") },
items: [id("talos-serve-public"), id("talos-serve-admin")],
},
],
}

export default talosCliReference
20 changes: 18 additions & 2 deletions sidebars-oel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,25 @@ import {
SidebarItem,
SidebarItemConfig,
} from "@docusaurus/plugin-content-docs/src/sidebars/types"
import talosApiSidebar from "./docs/talos/reference/api/sidebar"
import talosCliReference from "./docs/talos/reference/cli/sidebar"

type SidebarItemsConfig = SidebarItemConfig[]

// The generated Talos API sidebar is [overview doc, { category "ApiKeys", items: [...methods] }].
// Lift the methods into a single "API reference" category linked to the overview page so the
// navigation reads cleanly instead of exposing the raw OpenAPI tag name.
const talosApiReference = {
type: "category",
label: "API reference",
link: { type: "doc", id: "talos/reference/api/ory-talos-api" },
items: talosApiSidebar.flatMap((item: any) =>
typeof item === "object" && "items" in item && Array.isArray(item.items)
? item.items
: [],
),
}

const oelSidebar = [
{
type: "category",
Expand Down Expand Up @@ -576,8 +592,8 @@ const oelSidebar = [
label: "Reference",
items: [
"talos/reference/index",
"talos/reference/api/ory-talos-api",
"talos/reference/cli/talos",
talosApiReference,
talosCliReference,
"talos/reference/config",
"talos/reference/token-format",
"talos/reference/events",
Expand Down
21 changes: 19 additions & 2 deletions sidebars-oss.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
import talosApiSidebar from "./docs/talos/reference/api/sidebar"
import talosCliReference from "./docs/talos/reference/cli/sidebar"

// The generated Talos API sidebar is [overview doc, { category "ApiKeys", items: [...methods] }].
// Lift the methods into a single "API reference" category linked to the overview page so the
// navigation reads cleanly instead of exposing the raw OpenAPI tag name.
const talosApiReference = {
type: "category",
label: "API reference",
link: { type: "doc", id: "talos/reference/api/ory-talos-api" },
items: talosApiSidebar.flatMap((item: any) =>
typeof item === "object" && "items" in item && Array.isArray(item.items)
? item.items
: [],
),
}

const ossSidebar = [
{
type: "category",
Expand Down Expand Up @@ -582,8 +599,8 @@ const ossSidebar = [
label: "Reference",
items: [
"talos/reference/index",
"talos/reference/api/ory-talos-api",
"talos/reference/cli/talos",
talosApiReference,
talosCliReference,
"talos/reference/config",
"talos/reference/token-format",
"talos/reference/events",
Expand Down
Loading