Document Shark Explorer on the docs site - #2928
Merged
Merged
Conversation
pyricau
force-pushed
the
shark-explorer-docs
branch
2 times, most recently
from
August 4, 2026 05:08
c771e10 to
45624bc
Compare
The release notes described the app in three lines because there was nowhere to send anyone, so the first release would have gone out with no way to find out what the thing is. This is that page, and the release now links to it. The change log page names the app in its first line, so that link is the way in from a release note, which points at the change log rather than here. No screenshots: the UI is still moving too fast for a picture of it to stay true. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
pyricau
force-pushed
the
shark-explorer-docs
branch
from
August 5, 2026 05:40
45624bc to
d7ca6a6
Compare
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.
Shark Explorer had no user-facing page, so #2926's release notes described the app in three lines and linked nowhere. This is the page, and the release now links to it instead of describing itself.
#2926 has merged, so this is rebased onto
mainand is one commit,d7ca6a6, touching five files.The page
docs/shark-explorer.md, indocs/shark.md's voice: what it is and what question it answers, how to install it, how to open a heap dump, how to read the map, where the log file is, and how to run it from source. Two screens, no screenshots — the UI is still moving too fast for a picture of it to stay true.Wiring
OverviewjoinsChange LogunderShark Explorerin the nav, above the change log rather than below it.drag the app to Applications, ismain's.No entry in either change log: a docs page is not a change to the app, and
docs/changelog.mdis the libraries'.Verified
mkdocs buildadds no warning of its own, and every cross-link resolves, including the new one from the change log page. The two warnings it does print aredocs/api/not being generated in this worktree, which is true onmaintoo.The two code scanning comments above are stale
github-advanced-security[bot]flagged bothsetup-gradlesteps inrelease-shark-explorer.yml(zizmor'scache-poisoningaudit) while this branch was stacked on #2926. Those lines were #2926's, not this PR's, and they were fixed there inc599311— both steps now passcache-disabled: true. The comments predate that commit and the rebase onto it.🤖 Generated with Claude Code