docs: add generated code docs and code-docs CI job - #69
Open
ntlaletsi70 wants to merge 1 commit into
Open
Conversation
This repo was missing the docs/code + gomarkdoc convention that environments, environments-controller, and environments-api already have. Adds: - docs/code/ — initial gomarkdoc output for ./... (4 packages: root, cmd, scripts, util — all now documented) - .github/workflows/code-docs.yml — regenerates and commits docs/code on every push to main, mirroring the sibling repos' job. No private-module git config step since this repo has no blanketops/* module dependencies (it resolves sibling releases at runtime via .../releases/latest/... URLs). Co-Authored-By: Claude Sonnet 5 <[email protected]>
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
docs/code/+ gomarkdoc convention thatenvironments,environments-controller, andenvironments-apialready followdocs/code/content (4 packages: root,cmd,scripts,util) — all now documented.github/workflows/code-docs.yml, scoped toenvironments-clionly, to keep docs regenerated on every push tomain. No private-module git config step, since this repo has noblanketops/*module dependencies.Test plan
gomarkdoc --output 'docs/code/{{.Dir}}.md' ./...ran clean, output matches every package ingo list ./...code-docs.ymljob runs and produces a no-op diff on the next push🤖 Generated with Claude Code