Skip to content

chore: publish CLI docs to docs-new as MDX#210

Open
dylantientcheu wants to merge 1 commit intomainfrom
chore/docs-new-cli-reference
Open

chore: publish CLI docs to docs-new as MDX#210
dylantientcheu wants to merge 1 commit intomainfrom
chore/docs-new-cli-reference

Conversation

@dylantientcheu
Copy link
Copy Markdown
Collaborator

@dylantientcheu dylantientcheu commented Apr 22, 2026

Summary GROUT-177

  • update release automation to open docs PRs against algolia/docs-new
  • generate nested MDX command pages under doc/tools/cli/commands instead of flat YAML files
  • add focused coverage for recursive command traversal and nested MDX output

Test plan

  • go test ./cmd/docs ./internal/docs ./pkg/cmd/describe

Generate CLI command docs for the current docs site so releases stop opening PRs against the archived repo and publish nested MDX pages in the new docs tree.

Made-with: Cursor
@codacy-production
Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 1 high

Alerts:

⚠ 1 issue (≤ 0 issues of at least high severity)

Results:
1 new issue

Category Results
Security 1 high

View in Codacy

🟢 Metrics 5 complexity · 0 duplication

Metric Results
Complexity 5
Duplication 0

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Comment thread cmd/docs/main.go
Comment on lines +39 to +41
if *target != "old" && *target != "new" {
return fmt.Errorf("error: --target can only be 'old' or 'new' ('new' by default)")
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: Do we need to keep old as target? If not, we can remove target flag altogether

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