Skip to content

docs: add reference docs converted from talosctl#50

Merged
rothgar merged 1 commit into
siderolabs:mainfrom
rothgar:1.11-reference
Oct 7, 2025
Merged

docs: add reference docs converted from talosctl#50
rothgar merged 1 commit into
siderolabs:mainfrom
rothgar:1.11-reference

Conversation

@rothgar

@rothgar rothgar commented Oct 6, 2025

Copy link
Copy Markdown
Member

Update docs-convert to handle more edge cases and formatting and add a comment to note docs are automatically generated. Remove examples from inside reference tables. they don't render properly on mintlify and currently only work for hugo.

@github-project-automation github-project-automation Bot moved this to To Do in Planning Oct 6, 2025
@talos-bot talos-bot moved this from To Do to In Review in Planning Oct 6, 2025
Comment thread talos-v1.11.yaml
- group: "Reference"
folder: "talos/v1.11/reference"
pages:
- "v1alpha1/config.mdx"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to bring this up to the top level of the references because it's the most common and important configuration to reference. All other configuration folders were flattened into 1 page if there was only 1 configuration in that group.

image

We could keep the groups but then someone has to expand the section before they can see the config documents in that group (IMO it's annoying)

@rothgar

rothgar commented Oct 6, 2025

Copy link
Copy Markdown
Member Author

@smira smira removed this from Planning Oct 7, 2025
Update docs-convert to handle more edge cases and formatting and add a
comment to note docs are automatically generated. Fix multi-line example
formatting inside according boxes too.

Signed-off-by: Justin Garrison <justin.garrison@siderolabs.com>
@rothgar rothgar merged commit e7a7029 into siderolabs:main Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants