Skip to content

chore: retire configdocsgen - #1035

Merged
alexluong merged 1 commit into
mainfrom
chore/retire-configdocsgen
Aug 11, 2026
Merged

chore: retire configdocsgen#1035
alexluong merged 1 commit into
mainfrom
chore/retire-configdocsgen

Conversation

@alexluong

Copy link
Copy Markdown
Collaborator

Takes the "retire the generator" option from #820.

cmd/configdocsgen reflected over internal/config and injected generated env-var and YAML blocks into docs/pages/references/configuration.mdx, between MDX placeholders. That page went away with the move to Markdoc, so the tool wrote to a path that no longer exists:

$ make docs/generate/config
Warning: Output file docs/pages/references/configuration.mdx does not exist. A new file will be created with placeholders.
Error generating docs: failed to write updated content to docs/pages/references/configuration.mdx: open docs/pages/references/configuration.mdx: no such file or directory
exit status 1

Its replacement, docs/content/self-hosting/configuration.mdoc, is curated — grouped into sections with prose around them, a different shape from the generator's single table — and carries no autogen placeholders. There is nothing left for the generator to fill in.

Changes

  • Delete cmd/configdocsgen.
  • Drop the docs/generate/config Make target.
  • contributing/config.md step 6 now says to edit configuration.mdoc by hand. It previously pointed at go generate ./internal/config/..., and the //go:generate directive it names no longer exists either.

The historical plan under contributing/.plans/ still describes the generator; left as-is since it is a dated record.

Closes #820

🤖 Generated with Claude Code

The generator injected env-var and YAML blocks into
docs/pages/references/configuration.mdx between MDX placeholders. That
page went away with the move to Markdoc, so the tool wrote to a path that
no longer exists and `make docs/generate/config` failed outright.

Its replacement, docs/content/self-hosting/configuration.mdoc, is
curated — grouped into sections with prose around them — rather than one
generated table, so there is nothing left for the generator to fill in.

Closes #820

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@alexluong
alexluong merged commit 266a521 into main Aug 11, 2026
3 checks passed
@alexluong
alexluong deleted the chore/retire-configdocsgen branch August 11, 2026 17:52
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.

Decide fate of cmd/configdocsgen after Markdoc docs refactor

2 participants