Commit 801a8c8
committed
docs: fix stale references, casing, and index gaps ahead of release
Release-prep proofreading sweep over the root governance docs and the
docs/ tree. Generated artifacts (THIRD_PARTY_NOTICES.md, conformance
evidence) and historical ADRs under docs/design/ were left untouched.
Correctness:
- Key Packages listed pkg/validator/helper, which does not exist; the
package is validators/helper.
- docs/README.md "Find Your Path" pointed the Integrator row at
integrator/automation.md instead of the section index.
- Tech Stack claimed "Kubernetes 1.33+", unchanged since repo init while
k8s.io/api moved to v0.36.3 and kindest/node to v1.36.1. Unpinned from
that line, as golangci-lint already was in #925.
- contributor/recipe.md claimed deployers other than argocd-helm have no
supported install-time value surface. --dynamic is supported on helm,
flux, and helmfile; only plain argocd rejects it. Reworded to describe
the actual split: the bundle-time gate is the whole enforcement for
those three (closed surface, only declared paths), argocd-helm needs an
additional template-time guard because it exposes the parent chart's
.Values openly, and plain argocd has no such surface.
Stale versions: three example image/tarball tags had drifted apart
(0.15.0, v0.11.1, v0.1.0); normalized to v0.19.0.
Terminology: ArgoCD -> Argo CD (3 sites vs 101 already correct), TCPxO ->
TCPXO (3 vs 37), GPU Daemonsets -> DaemonSets, vanilla kubernetes ->
Kubernetes, and a sentence-initial "Argocd-helm" reworded.
Completeness: the api-reference component table was missing 7 registry
components and had the mariadb-* rows out of order; user/index.md was
missing fabric-attached-training.md; contributor/index.md was missing
four pages that exist but were unlinked. Dropped an agent attribution
from an investigation-doc byline.
Signed-off-by: Yuan Chen <yuanchen97@gmail.com>1 parent 31970aa commit 801a8c8
16 files changed
Lines changed: 41 additions & 24 deletions
File tree
- .claude
- docs
- contributor
- integrator
- components
- user
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
119 | | - | |
| 119 | + | |
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
119 | | - | |
| 119 | + | |
120 | 120 | | |
121 | 121 | | |
122 | 122 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
77 | | - | |
| 77 | + | |
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
315 | 315 | | |
316 | 316 | | |
317 | 317 | | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
318 | 322 | | |
319 | 323 | | |
320 | 324 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
264 | | - | |
265 | | - | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
266 | 271 | | |
267 | 272 | | |
268 | 273 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
| 92 | + | |
93 | 93 | | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
97 | | - | |
| 97 | + | |
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
0 commit comments