Repository navigation
Add CLI doc generator, guides, and docs-publish workflow - #5
Merged
Merged
Conversation
added 2 commits
January 23, 2026 12:39
- internal/tools/docgen: Walks Cobra command trees and generates Docker-style markdown pages with Astro frontmatter - cmd/docgen: Entry point importing both writ and lore root commands - docs/guides: Hand-written overview materials (getting started, writ concepts, lore pipeline, secrets, manifests, registry) - .github/workflows/docs-publish.yaml: On push to develop/release*/main, generates CLI docs and opens PR on the site repo with both generated reference pages and hand-written guides - Makefile: Added 'docs' target - .gitignore: Added docs/cli/ (generated output)
Interactive script that guides through creating a fine-grained PAT with the correct permissions (Contents + Pull requests on the site repo), validates the token, and sets it as SITE_DEPLOY_TOKEN secret on devlore-cli. Run periodically to rotate before expiration.
David-Noble-at-work
pushed a commit
that referenced
this pull request
Jun 7, 2026
Both were at status: draft despite shipped work; neither is complete (the #6 veneer remains): - platform-unification.md (step 21.4): the op-free pkg/platform Composite reshape (#1-4) is committed; remaining are #5 (delete the redundant op managers) and #6 (the pkg.Provider veneer + consumer migration), both still scoped in its Work breakdown -> in-progress. - pkg-install-reconciler.md (#9 + #6): #9 Update is complete (Part A manual + Part B auto-gate, committed cd92631); the stale "Remaining: #9 Part B" status line is corrected; #6 veneer remains -> in-progress.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cmd/docgentool that walks both writ and lore Cobra command trees and generates Docker-style CLI reference pages (markdown with Astro frontmatter)docs/guides/with 10 hand-written overview docs covering getting started, writ concepts (environments, platform awareness, secrets, repositories), and lore concepts (deployment, pipeline, manifests, registry).github/workflows/docs-publish.yamlthat triggers on push to develop/release*/main, generates CLI docs, and opens a PR on the site repo with both generated reference pages and hand-written guidesdocsMakefile target and.gitignoreentry for generated outputTest plan
go build ./cmd/docgen/compiles cleanlygo vet ./internal/tools/docgen/ ./cmd/docgen/passesmake docsgenerates 63 CLI reference pages (32 writ + 29 lore + 2 roots)