Skip to content

Document Shark Explorer on the docs site - #2928

Merged
pyricau merged 1 commit into
mainfrom
shark-explorer-docs
Aug 5, 2026
Merged

Document Shark Explorer on the docs site#2928
pyricau merged 1 commit into
mainfrom
shark-explorer-docs

Conversation

@pyricau

@pyricau pyricau commented Aug 3, 2026

Copy link
Copy Markdown
Member

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 main and is one commit, d7ca6a6, touching five files.

The page

docs/shark-explorer.md, in docs/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.

Rendered page, top

Rendered page, bottom

Wiring

  • Overview joins Change Log under Shark Explorer in the nav, above the change log rather than below it.
  • The change log page names the app in its first line, so that link is now the way in from a release note, which points at the change log rather than at this page.
  • Shark's "released in layers" list gains an entry for the app, between Shark CLI and LeakCanary.
  • The release notes swap their three-line description for a link to the page. The rest of that block, including the "What changed" link and drag the app to Applications, is main's.

No entry in either change log: a docs page is not a change to the app, and docs/changelog.md is the libraries'.

Verified

  • mkdocs build adds 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 are docs/api/ not being generated in this worktree, which is true on main too.
  • The screenshots above are that build, served and rendered, not the Markdown read by eye.
  • The release notes still parse as YAML, and the block scalar still comes out as Markdown rather than as one code block.
  • The download table's filenames match what the workflow's rename steps actually produce.

The two code scanning comments above are stale

github-advanced-security[bot] flagged both setup-gradle steps in release-shark-explorer.yml (zizmor's cache-poisoning audit) while this branch was stacked on #2926. Those lines were #2926's, not this PR's, and they were fixed there in c599311 — both steps now pass cache-disabled: true. The comments predate that commit and the rebase onto it.

🤖 Generated with Claude Code

Comment thread .github/workflows/release-shark-explorer.yml Fixed
Comment thread .github/workflows/release-shark-explorer.yml Fixed
@pyricau
pyricau force-pushed the shark-explorer-docs branch 2 times, most recently from c771e10 to 45624bc Compare August 4, 2026 05:08
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
pyricau force-pushed the shark-explorer-docs branch from 45624bc to d7ca6a6 Compare August 5, 2026 05:40
@pyricau
pyricau merged commit 6b95ccd into main Aug 5, 2026
16 checks passed
@pyricau
pyricau deleted the shark-explorer-docs branch August 5, 2026 05:51
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