Skip to content

docs(site): content audit + refresh across all pages for 1.5.0 accuracy#264

Merged
rlaope merged 1 commit into
masterfrom
feat/site-content-refresh
May 30, 2026
Merged

docs(site): content audit + refresh across all pages for 1.5.0 accuracy#264
rlaope merged 1 commit into
masterfrom
feat/site-content-refresh

Conversation

@rlaope
Copy link
Copy Markdown
Owner

@rlaope rlaope commented May 29, 2026

What

A content audit + refresh of the documentation site (design/structure unchanged β€” this is about what the pages say). Every page was audited against the actual code/docs via parallel review, and each finding was re-verified against source before editing.

Factual corrections (verified against source)

Page Fix
reference.html Module architecture 7 β†’ 11 (adds argus-diagnostics, argus-aggregator, argus-operator, argus-instrument). Config table: argus.buffer.size=65536 (was argus.buffer-size=131072), argus.cpu.interval=1000 (was .interval-ms=500), argus.allocation.threshold=1048576 (was 524288); +12 missing knobs (server.enabled, profiling.interval, contention.threshold, correlation.enabled, otlp.*, metrics.legacyNames, anomaly.mode).
integrations.html Spring YAML defaults fixed (65536/1000/1048576); add argus.mode; complete the actuator surface (argus-doctor, argus-gc, + mode=full-only health caveat); doctor.gc-log-path requirement; scheduling note; DoctorService.lastCollectionWarnings().
dashboard.html argus.server.enabled default is true (was documented false); +missing config rows; note jdk.VirtualThreadSubmitFailed.
scenarios.html S6 used argus classloader --top (no such flag) β†’ argus classleak.
commands.html ZGC --watch=N is iterations, not seconds.

Completeness

  • commands.html: the "All 71 Commands" reference listed only ~24 β€” now covers all 71 across 8 categories, with the newer commands documented (rightsize, instrument, explain --llm, heapanalyze, gcscore, profile-gate, …).
  • index.html: new capability cards β€” JVM right-sizing (FinOps), learned anomaly detection, OTel-native semconv metrics, opt-in LLM root-cause; corrected the virtual-thread card (JEP-491 taxonomy, structured-concurrency view, carrier-saturation argus doctor rule); broadened "two tools" β†’ CLI/Agent/Spring starter/diagnostics library.
  • comparison.html: framing broadened beyond GC; pool jdbc / pool advise surfaced.
  • scenarios.html: argus rightsize added to the OOMKilled scenario, an argus instrument confirmation step to lock contention, and a new scenario 13 (virtual-thread carrier saturation) β€” a flagship 1.5 capability that previously had no scenario home.

Honesty / accuracy guards

  • Opt-in features (LLM, instrument, learned anomaly) are labelled opt-in (honest-value-framing rule).
  • A proposed Micrometer "legacyNames" note was dropped β€” that dual-emit lives in argus-server, not argus-micrometer; adding it would be a false claim.
  • Verified: every argus <cmd> invocation resolves to a real command (caught + fixed one hallucinated argus vthread); v1.5.0 and 71 commands consistent across all pages; HTML tag balance OK on all 7 pages; the GitHub Pages assembly reproduces with assets resolving.

πŸ€– Generated with Claude Code

Audited every site page's CONTENT against the actual code/docs and fixed
inaccuracies, staleness, and gaps (design/structure unchanged).

Factual corrections (verified against source):
- reference.html: module architecture 7 β†’ 11 (add argus-diagnostics,
  -aggregator, -operator, -instrument); fix wrong config property names/defaults
  (argus.buffer.size=65536 not argus.buffer-size=131072; argus.cpu.interval=1000
  not .interval-ms=500; argus.allocation.threshold=1048576 not 524288); add the
  missing knobs (server.enabled, profiling.interval, contention.threshold,
  correlation.enabled, otlp.*, metrics.legacyNames, anomaly.mode).
- integrations.html: fix Spring starter YAML defaults (65536/1000/1048576), add
  argus.mode, the argus-doctor/argus-gc actuator endpoints + mode=full health
  caveat, doctor.gc-log-path requirement, scheduling note, DoctorService method.
- dashboard.html: argus.server.enabled default is true (was documented false);
  add missing config rows; note jdk.VirtualThreadSubmitFailed.
- scenarios.html: S6 used `argus classloader --top` (no such flag) β†’ `argus
  classleak`; ZGC flag semantics elsewhere.
- commands.html: ZGC --watch=N is iterations, not seconds.

Completeness:
- commands.html: the "All 71 Commands" reference listed ~24; now covers all 71
  grouped into 8 categories, with the newer commands documented (rightsize,
  instrument, explain --llm, heapanalyze, gcscore, profile-gate, …).
- index.html: add capability cards for JVM right-sizing (FinOps), learned
  anomaly detection, OTel-native semconv metrics, and opt-in LLM root-cause;
  correct the virtual-thread card (JEP-491 taxonomy, structured-concurrency view,
  carrier-saturation doctor rule); broaden "two tools" β†’ CLI/Agent/Spring
  starter/diagnostics library; broaden the Integrations pointer.
- comparison.html: broaden framing beyond GC; add `pool jdbc` / `pool advise`.
- scenarios.html: add `argus rightsize` to the OOMKilled scenario, an `argus
  instrument` confirmation step to lock contention, and a new scenario 13
  (virtual-thread carrier saturation).

Honest-value-framing preserved: opt-in features (LLM, instrument, learned
anomaly) are labelled as such; a proposed Micrometer "legacyNames" note was
dropped because that dual-emit lives in argus-server, not argus-micrometer.
Version (v1.5.0) and command count (71) kept consistent; all `argus <cmd>`
invocations resolve to real commands; HTML tag balance verified.

Signed-off-by: rlaope <piyrw9754@gmail.com>
@rlaope rlaope merged commit 1ea16ad into master May 30, 2026
11 checks passed
@rlaope rlaope deleted the feat/site-content-refresh branch May 30, 2026 00:48
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.

1 participant