Skip to content

docs: add product and Helm chart name conrefs for the enterprise import - #507

Merged
Rachael-Graham merged 1 commit into
mainfrom
rlg-name-conrefs
Sep 22, 2026
Merged

Rachael-Graham merged 1 commit into
mainfrom
rlg-name-conrefs

Conversation

@Rachael-Graham

Copy link
Copy Markdown
Contributor

What

Adds four conrefs under docs-site/assets/kagent-docs/snippets/ and wires them into the 1.x pages, so the enterprise import can rebrand this prose instead of hand-forking the pages.

Conref Value here
helm-path.md oci://ghcr.io/kagent-dev/kagent/helm
helm-kagent.md kagent
helm-kagent-crds.md kagent-crds
name-product.md kagent

Why

solo-io/docs rebases these pages verbatim, so today 1.x prose reaches the enterprise site saying "kagent" where it should say "Solo Enterprise for kagent", and the install commands point at the OSS chart. A conref with an enterprise twin at the same path fixes that per file; one without a twin renders this repo's value silently.

Nothing renders differently on kagent.dev. Every conref resolves to the value that was previously inline — verified against a full make build-docs.

Scope

  • Helm: all 8 chart references, in setup/installation (x2), agents/agent-memory, observability/audit-prompts (x2), observability/tracing (x2) and operations/operational-considerations. helm-path deliberately carries the whole structural difference between the two registries (/helm vs /charts), so nothing left literal at a call site is correct for only one side. Release names and the kagent namespace stay literal, being identical on both sides.
  • Product name: the first product mention on 24 pages, out of 833 standalone prose occurrences. Left alone on purpose: headings (a conref changes the anchor on one side only), component names such as the kagent controller and the kagent CLI, link text, reference/community.md (it describes the open-source project), and reference/helm.md (generated by update-ref-docs.yaml, so an edit there would be reverted on the next run).

Restraint is the point rather than edit cost: even downstream, "Solo Enterprise for kagent" is a first-mention brand name, so substituting all 833 would read worse, not better.

Merge order

First of three. Then solo-io/enterprise-kagent, then solo-io/docs — the downstream build reads this repo's main through a git worktree, so these calls must land here before the enterprise halves can do anything.

🤖 Generated with Claude Code

The enterprise import rebases these pages verbatim into solo-io/docs, so
1.x prose arrived downstream saying "kagent" where it should say "Solo
Enterprise for kagent", and the install commands pointed at the OSS chart.

Adds four conrefs under assets/kagent-docs/snippets/ and wires them up:

- helm-path, helm-kagent and helm-kagent-crds across the 8 chart references
  in setup/installation, agents/agent-memory, observability/audit-prompts,
  observability/tracing and operations/operational-considerations. helm-path
  deliberately carries the whole structural difference between the two
  registries (/helm vs /charts) so that no literal left at a call site is
  correct for only one side. Release names and the kagent namespace stay
  literal, being identical on both sides.

- name-product at the first product mention on 24 pages. Component names
  such as the kagent controller and the kagent CLI, link text, headings,
  reference/community.md and the generated reference/helm.md are left alone.

Rendered output on this site does not change: every conref resolves to the
value that was previously inline.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Rachael Graham <rachael.graham@solo.io>
@Rachael-Graham
Rachael-Graham merged commit 4c7ce61 into main Sep 22, 2026
6 checks passed
@Rachael-Graham
Rachael-Graham deleted the rlg-name-conrefs branch September 22, 2026 22:04
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.

2 participants