Skip to content

feat: remove double title in docs and hide from sidebar#110

Merged
gianarb merged 1 commit intomainfrom
feat/apply-docs-markdown-transformation
Feb 24, 2026
Merged

feat: remove double title in docs and hide from sidebar#110
gianarb merged 1 commit intomainfrom
feat/apply-docs-markdown-transformation

Conversation

@gianarb
Copy link
Collaborator

@gianarb gianarb commented Feb 24, 2026

The cobra generated markdown is not ideal and it needs to be tweaked a
bit in order to look right in datum.net but cobra does not offer a hook
to apply transformations during generation.

For this reason I had to implement a transformation mechanism as
second step.

There are two transformations asked by Felix:

  1. Lowercase link "SEE ALSO" to "See also"
  2. Move h1 header to h3

We want to hide the majority of the generated commands from sidebar to
avoid having too many items in there. This PR does that.

It also replaces the name of the datumctl doc with CLI reference since
it is the entrypoint for the cli reference.
@gianarb gianarb force-pushed the feat/apply-docs-markdown-transformation branch from cc85df2 to c602a3b Compare February 24, 2026 10:47
@gianarb gianarb changed the title feat: implement transformation mechanism to improve generated cli docs feat: remove double title in docs and hide from sidebar Feb 24, 2026
@gianarb gianarb requested a review from scotwells February 24, 2026 10:48
@gianarb gianarb enabled auto-merge February 24, 2026 10:48
@gianarb gianarb merged commit fcf222c into main Feb 24, 2026
2 checks passed
@gianarb gianarb deleted the feat/apply-docs-markdown-transformation branch February 24, 2026 18:09
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.

2 participants