docs(site): content audit + refresh across all pages for 1.5.0 accuracy#264
Merged
Conversation
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>
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
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.
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)
argus-diagnostics,argus-aggregator,argus-operator,argus-instrument). Config table:argus.buffer.size=65536 (wasargus.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).argus.mode; complete the actuator surface (argus-doctor,argus-gc, +mode=full-only health caveat);doctor.gc-log-pathrequirement; scheduling note;DoctorService.lastCollectionWarnings().argus.server.enableddefault is true (was documentedfalse); +missing config rows; notejdk.VirtualThreadSubmitFailed.argus classloader --top(no such flag) βargus classleak.--watch=Nis iterations, not seconds.Completeness
rightsize,instrument,explain --llm,heapanalyze,gcscore,profile-gate, β¦).argus doctorrule); broadened "two tools" β CLI/Agent/Spring starter/diagnostics library.pool jdbc/pool advisesurfaced.argus rightsizeadded to the OOMKilled scenario, anargus instrumentconfirmation 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
instrument, learned anomaly) are labelled opt-in (honest-value-framing rule).argus-server, notargus-micrometer; adding it would be a false claim.argus <cmd>invocation resolves to a real command (caught + fixed one hallucinatedargus vthread);v1.5.0and71 commandsconsistent across all pages; HTML tag balance OK on all 7 pages; the GitHub Pages assembly reproduces with assets resolving.π€ Generated with Claude Code