docs: sync command count to 71, tighten Why Argus, document rightsize#261
Merged
Conversation
Bump the documented CLI command count from 70 to 71 across README, docs, and the site (a new rightsize command was added). Compress the README "Why Argus?" highlight list into a tighter value-first set, and fully document the new rightsize command in the CLI reference A-Z index and the runtime-internals page (synopsis, options, OOMKill tri-state, JSON output, and the GET /fleet/rightsize aggregator roll-up). 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
1 participant
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.
Command-count drift (70 → 71)
A new
rightsizecommand landed, so the documented CLI command count was stale at 70. Updated to 71 everywhere:README.md— taglinedocs/getting-started.md— Java compatibility tabledocs/README.md— reference indexdocs/cli-commands.md— reference introsite/index.html— badge + two prose mentionssite/commands.html— section headingsite/reference.html— compatibility table + module table"Why Argus?" compression (README)
Rewrote the README
## Why Argus?highlight list into a tighter, value-first set led by a one-line positioning statement.rightsizeis now surfaced as a highlight;snapshot/pooldetail was relocated out of the headline list but remains fully documented underdocs/.New
rightsizecommand docsrightsizewas previously undocumented. Added it to:docs/cli-commands.md(alphabetical, under Runtime & JVM Internals)docs/commands/runtime-internals.mdmatching the page's existing format — synopsis, example output, options table, and accurate behavior: recommends-Xmx/-Xms, container memory request/limit, and CPU request from the observed heap high-water-mark / post-GC live-set floor / alloc & promotion rate / metaspace + direct-buffer footprint; never recommends below the live-set floor; the OOMKill-risk tri-state (AT_RISK/OK/UNKNOWN, whereUNKNOWN= no observed container limit);--limit=<size>;--format=json; and theGET /fleet/rightsizeaggregator roll-up.Verification
./gradlew :argus-cli:test --quiet→ exit 0.gradle.propertiestouched.🤖 Generated with Claude Code