docs: adopt the Krateo Documentation Standard - #19
Merged
Conversation
Library-profile bundle: README thin skeleton + docs/{index,overview,usage,
configuration,api,examples,release,log}.md + docs/llms.txt + a runnable
examples/minimal (crdgen values.schema.json -> CRD, part of the module so
`go build ./...` keeps it compiling). Every claim traced to current source:
the helm/v3 apply-if-changed Reconcile flow from reconcile.go, the exported
package map from the actual package docs, env vars from the code
(HELM_DRIVER, CLUSTER_NAME, in-cluster host/port), the tag-only release
convention from the real tag history (v1.13.2 current, off-main v1.7.x
maintenance line). Dead-org badge links in the README replaced with the
current module identity (go.mod says krateo-platformops since v1.13.0).
CI: appended the shared lint-docs reusable to test.yaml; the extracted
linter exits 0 from the repo root.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LJsLqtryCgWwEt8FnPE1se
usage.md claimed core-provider and composition-dynamic-controller both pin plumbing v1.13.2; CDC main (v1.4.0) actually pins v1.13.0. State the two pins separately. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LJsLqtryCgWwEt8FnPE1se
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.
Converts plumbing to the Krateo Documentation Standard, library profile (
index type: Library).What's in the bundle
go.modisgithub.com/krateo-platformops/plumbingsince v1.13.0, so old-org references were bugs, not intentional upstream paths).Library) — the map; also curates the code-adjacentcrdgen/docs/ref-resolution-redesign.mddesign record.helm/v3fork-free apply-if-changedReconcileengine (flow traced step-by-step fromhelm/v3/reconcile.go),crdgen, thelabelscompile-time cross-repo contract, the kubeutil family, and how core-provider (crdgen, objectclient/hasher/rbacgen — pins v1.13.2) and composition-dynamic-controller (Client.Reconcilein Observe) consume it.go get+ the real pinning conventions: exact tags only, contract packages same-version on both sides, module identity since v1.13.0, the tag→consumer-bump→installer-pin chain.HELM_DRIVER,CLUSTER_NAME,KUBERNETES_SERVICE_HOST/PORT;AUTHN_JWT_SECRETis a key-NAME constant (CreateToken takes the key via options — its doc comment claiming an env read is stale relative to the code); test-only build tagsenvtest/integration.v-prefixed semver (unlike the chart/image repos), off-mainv1.7.xmaintenance line through v1.7.16 verified against the tag graph.values.schema.jsontocrdgen.Generateand prints the CRD. Part of the module, sogo build ./...compiles it; verified withgo build,go vetandgo run.CI
Appended the shared
lint-docsreusable (krateo-platformops/.github/.github/workflows/lint-docs.yaml@main) as a second job in the existing PR workflow (test.yaml). The extracted inline linter run from the repo root exits 0 errors, 0 warnings.No code changes outside
examples/and the workflow append.🤖 Generated with Claude Code