docs: adopt the Krateo Documentation Standard - #33
Merged
Conversation
Convert the bundle to the invariant OKF file set (ChartRepo index): thin
README skeleton, docs/{index,overview,usage,configuration,api,examples,
release,log}.md + rewritten docs/llms.txt, and a runnable
examples/observability-composition. Every claim re-derived from the four
charts (rendered via helm template with vendored deps) and the installer
component pins; docs/wiring.md and docs/crds.md folded into
configuration.md / api.md.
Divergences fixed while re-verifying:
- compositiondefinition.yaml pointed at the nonexistent OCI artifact
charts/observability@0.1.8 -> charts/krateo-observability@0.1.11 (the
release workflow publishes by chart name; verified against GHCR).
- README/old docs still described the pre-migration layout (kagent/ agent
chart, CHART_VERSION placeholder versioning, stale image tags 1.0.0,
fullnameOverride krateo-observability, the inert http-handlers ConfigMap
as if live) — all rewritten to current source.
- The stale template-comment claim that upstream emits a
krateo-clickstack-app Service corrected in docs: the rendered upstream
Service is krateo-clickstack (3000/app, 4320/opamp).
CI: lint.yaml now also calls the shared lint-docs reusable
(krateo-platformops/.github). Chart values/templates untouched (PR #32
owns the probe changes).
Co-Authored-By: Claude Opus 4.8 <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 this chart repo to the Krateo Documentation Standard at pilot depth: the invariant OKF file set (
type: ChartRepoindex), a thin routing README, a runnable example, and the sharedlint-docsconformance job. The extracted-linter run from repo root exits 0.What changed
docs/bundle —index / overview / usage / configuration / api / examples / release / log.md + rewrittenllms.txt, all with OKF frontmatter (resource:= the live OCI charts, timestamp 2026-08-07). Every claim was re-derived from current source: the four charts rendered viahelm templatewith vendored deps (clickstack 3.0.2,opentelemetry-collector 0.158.1), the installer'scomponent-pins.yaml, and GHCR itself.docs/wiring.md+docs/crds.mdfolded in — their (partly stale) content is fully superseded byconfiguration.mdandapi.md; nothing was kept unverified.examples/observability-composition/— CompositionDefinition +KrateoObservabilityCR (block YAML), pairedtype: ExampleREADME with preconditions and the one apply command.lint.yamlgains alint-docsjob callingkrateo-platformops/.github/.github/workflows/lint-docs.yaml@main(same org, plain reusable call).Divergences found & fixed while re-verifying
compositiondefinition.yamlpointed at a nonexistent artifact:oci://ghcr.io/krateo-platformops/charts/observability@0.1.8— the canonical release workflow publishes by chart name, and GHCR 404s that path. Re-pointed tocharts/krateo-observability@0.1.11(verified pullable).kagent/agent chart,CHART_VERSION-placeholder versioning (all four charts are literally pinned), OCI namescharts/observability/charts/sse-proxy, image tags1.0.0(nowotel-collector:1.0.2,sse-proxy:1.1.2),fullnameOverride: krateo-observability(actuallykrateo-clickstack), and theclickhouse-http-handlersConfigMap presented as live (inert since0.1.6;/eventslives incluster.spec.settings.extraConfig).krateo-clickstack(3000/app, 4320/opamp) — thehyperdx-loadbalancer.yamlcomment sayingkrateo-clickstack-appis the stale one; docs state the rendered truth.Deliberately untouched
Chart values/templates owned by open PR #32 (probe tolerances + Quantity typing) — no chart file is modified here; docs avoid asserting the probe tolerances it changes.
ops/runbooks stay code-adjacent, curated fromindex.md/llms.txt.🤖 Generated with Claude Code