docs: refresh listings descriptions (snap, README, binary size)#25
Merged
Conversation
- README.md: add Shift+Scroll-over-table row to view shortcuts (v0.1.11). - snap/snapcraft.yaml: expand description with features added since v0.1.3 (search Ctrl+F, resizable table columns, full-width toggle, click-to- enlarge images & diagrams, math rendering, Shift+wheel table scroll). Match the structure of the existing store-listing description. - CLAUDE.md + docs/TARGET_METRICS.md: correct stale ~8.7MB binary size to ~35 MB (release build) / ~7 MB (snap compressed); matches the value in README.md which was already accurate. - .github/workflows/release.yml: add `snapcraft push-metadata --from-yaml --force` step after the snap publish so future yaml description edits propagate to the Snap Store listing automatically. The store listing was hand-curated and previously diverged silently from the yaml.
2 tasks
aydiler
added a commit
that referenced
this pull request
May 24, 2026
One-shot resync for cases where the snap store description has drifted from snap/snapcraft.yaml (e.g. when a release predates the auto-push step added in PR #25). Trigger via 'gh workflow run snap-push-metadata.yml'. The release.yml publish-snap job handles this automatically from v0.1.12 onward; this workflow exists for manual one-offs.
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.
Summary
~8.7MBbinary size to~35 MB release/~7 MB snap. README.md was already accurate; the two internal docs lagged.snapcraft push-metadata --from-yaml --forceafter the snap publish step. The Snap Store listing description is curated separately from the snap upload; without push-metadata, yaml description edits don't propagate. With this step, future releases sync the store description automatically.One-time manual step still needed
The v0.1.11 release CI run is in flight as I write this and won't pick up the new push-metadata step (workflow code is read from the tag commit, which predates this PR). After this PR merges, the snap store listing will still show the old short description until the next release ships, OR until a manual one-time push:
snapcraft login # or set SNAPCRAFT_STORE_CREDENTIALS snapcraft push-metadata md-viewer_0.1.11_amd64.snap --from-yaml --forceFrom v0.1.12 onwards CI handles it.
Test plan
python3 -c "import yaml; yaml.safe_load(open('snap/snapcraft.yaml'))"parses cleanlysnapcraft push-metadatastep succeeds in CI on the next release