Skip to content

docs: align links and claims with current CI and StackRun control plane - #107

Merged
jmjava merged 1 commit into
mainfrom
cursor/docs-review-accuracy-098f
Sep 17, 2026
Merged

jmjava merged 1 commit into
mainfrom
cursor/docs-review-accuracy-098f

Conversation

@jmjava

@jmjava jmjava commented Sep 17, 2026

Copy link
Copy Markdown
Owner

Documentation review against the current tree: relative links, GitHub Actions triggers, CRD-primary Stack/StackRun flow, and test/Newman counts.

What was stale

  • README and docs/REGRESSION.md said cluster-regression never runs on PRs. It is nightly/tags/dispatch plus Helm/cluster-script path filters (isolation-eval skipped on those PRs). Intercept and Results are weekly plus their own path filters. Everyday PRs still get local regression, docgen smoke, and dependency review.
  • Orchestrator docs still said it creates PipelineRuns. Runtime path is StackRun → operator → PipelineRun. Mutation APIs require a bearer token.
  • C4 / pipeline description still showed PR RC version bumps. stack-pr-test uses snapshot tags and does not write versions.yaml.
  • Milestone and research text treated intercept E2E as parked/out-of-band even though intercept-e2e.yml and results-regression.yml exist. Live matrix evidence is still required (M17.3 / M17.4 stay unchecked).
  • Test counts: orchestrator 108, tekton-dag-common 89, GUI backend 68, Playwright 70, Newman 20/38.
  • Quick start omitted install-operator-kind.sh even though generate-run.sh applies StackRuns.
  • DO-THIS-LOCAL.md pointed at an old agent branch name.
  • Demo segment 19 was on Pages/index.html but missing from the root README table.

What this PR does

  • Refresh user-facing docs (README.md, docs/REGRESSION.md, docs/SCRIPTS.md, docs/MAINTENANCE.md, C4, research packaging notes, M16/M17).
  • Add scripts/check-markdown-links.py and run it from run-regression.sh (631 relative links passed; fenced example paths skipped).
  • Clarify workflow comments so Kind jobs are not described as “every PR” or “never on PRs.”

Historical milestone checkboxes (M10.1 Newman 15/30, M11 trigger form) and spoken demo narration were left as snapshots / in sync with existing videos.

Actions leftover names (deleted workflow files still listed in the GitHub UI) cannot be disabled from this token; disable them under Actions → workflow → ⋯ → Disable.

Open in Web Open in Cursor 

Refresh user-facing docs so GitHub Actions triggers, CRD-primary runs,
snapshot PR tags, and current test/Newman counts match the tree. Add a
relative Markdown link check to local regression.

Co-authored-by: jmjava <[email protected]>
@jmjava
jmjava marked this pull request as ready for review September 17, 2026 00:37
@jmjava
jmjava merged commit b5684ea into main Sep 17, 2026
9 checks passed
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