docs: bring the release runbook and the syntax reference up to 2.7.4 - #660
Merged
Merged
Conversation
Four claims in the docs describe behaviour that PRs since 2.7.3 changed, and two features shipped without reaching the file that documents what Markpad can do. RELEASING.md - snapcraft.yaml no longer builds the app; it unpacks the release's own .deb (#579), so the `npm ci` note and the `rust-deps` troubleshooting row both described a file that no longer exists in that shape (#577). - The .deb/.rpm coverage note still said *Check for Updates…* offers an update and then fails to install it. #573 asks `self_update_supported` first, so it says where updates come from instead. - Adds the AppImage checks (#584, #658) as their own troubleshooting row, and notes that release builds are serialized (#612). README, README.zh-CN - The same pre-#573 claim, in both languages. The Chinese one also told .deb/.rpm users to update "through their distribution channels", which is the sentence #566 removed from the English one — there is no apt or dnf repository. snapcraft.yaml - The comment pointed at .github/workflows/test_snap.yml, deleted in #601. samples/markdown-syntax{,.zh-CN}.md - Lists: Enter continues the marker, Tab changes level, Enter on an empty item leaves the list (#636), and the three list chords (#652). - Tables: cell, row and column keys, why deleting a row has no chord (#645, #653). - Links: Ctrl/Cmd+K (#652). npm test 904 pass, vitest 365 pass. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
added 3 commits
August 13, 2026 03:09
The syntax reference carries no issue numbers, no history and no defence of a decision anywhere in its 500 lines; where it does give a reason -- the three deliberate incompatibilities -- the reason tells the reader what to write instead. Two sentences I added argued for the design at the reader: that four other editors use Mod+K, and why deleting a row has no chord while deleting a column does. Neither changes anything the reader would type. What is left of the second is the part that was actually useful: to delete a row, delete its line.
#570 was the last issue number in either README, and it was one I added a few days ago. It is a closed bug report, and after #573 the sentence it was attached to describes ordinary behaviour -- so a reader asking "how does my .deb update" now clicks through to a fault that no longer exists. The half-sentence in front of it went for the same reason: "rather than offering one it cannot install" describes what the app used to do. What is left is what the reader needs -- .deb and .rpm are one-time installs, there is no apt or dnf repository, and Check for Updates says so. Both READMEs keep the Report a Bug link, which is the only issue link either of them had before.
This file is what you read on the day you cut a release. Over three days in August I turned it into a runbook with post-mortems threaded through it: which run pushed Chocolatey 2.7.2 at 15:37, that the snap served 2.6.11 for three months and six versions, which two of the three v2.7.2 attempts the AppImage strip failed in, how the 2.7.2/2.7.3 lock skew was found. All true, none of it changes what you do next, and it sits between you and step 5 while a build is running. Test applied to each one: can it change an action taken on release day. Gone: the "Why package managers publish after the release" section entirely -- its one operational sentence (workflow_dispatch works against a published tag, the only way to exercise snapcraft.yaml) moves into step 7, where you would need it. The failure histories in three troubleshooting rows, keeping the symptom and the fix. The placeholder-pubkey era. Two design defences. Kept: reasons that stop you doing the wrong thing -- why not to create anything at alecdotdev/Markpad, why the Cargo.lock bump is the one that gets forgotten. A prohibition without its reason gets deleted as superstition by whoever comes next. 1957 -> 1563 words. The version before I started was 883.
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.
Four claims in the docs describe behaviour that PRs since 2.7.3 changed, two features shipped without reaching the file whose job is to say what Markpad can do, and the release runbook had drifted into being something else.
npm test904 pass,npm run test:vitest365 pass.1. Claims that were no longer true
RELEASING.mdsnapcraft.yamlusesnpm ciand builds the snap outside Actions.deb(#579) and compiles nothing (#577)RELEASING.mdrust-depspart is gone or renamedrust-depspart and no rustup; the live failures are a missingmarkpad.deband thesnapcraftsnap moving under usRELEASING.md,README.md,README.zh-CN.md.deb/.rpmusers an update and then fails to install itself_update_supportedbefore the check and says where updates come fromREADME.zh-CN.md.deband.rpmusers update "通过各自的分发渠道"snapcraft.yaml.github/workflows/test_snap.ymlputs the.debthere2. The runbook is a runbook again
RELEASING.mdis what you read on the day you cut a release. Over three days in August I threaded post-mortems through it: which run pushed Chocolatey 2.7.2 at 15:37 UTC, that the Snap Store served 2.6.11 for three months and six versions, which two of the three v2.7.2 attempts the AppImage strip failed in, how the 2.7.2/2.7.3 lock skew was found. All true, none of it changes what you do next, and it sits between the reader and step 5 while a build is running.The test applied to every sentence: can it change an action taken on release day.
workflow_dispatchagainst a published tag is the only way to exercisesnapcraft.yaml) moves into step 7, where you would reach for it. The failure histories in three troubleshooting rows, keeping the symptom and the fix. The placeholder-pubkey era. Two design defences.alecdotdev/Markpad, why theCargo.lockbump is the one that gets forgotten. A prohibition without its reason gets deleted as superstition by whoever comes next.1957 → 1563 words. The version before I started on it was 883.
The same edit removed the last issue number from both READMEs.
#570was a closed bug report, and after #573 it hung off a sentence describing ordinary behaviour — a user asking "how does my.debupdate" clicked through to a fault that no longer exists. The Report a Bug link, which is what both files had before, stays.3. The syntax reference
samples/markdown-syntax.mdis what the README points users and their AI assistants at for "what can Markpad do". Two features landed since it was written:Entercontinues the marker,Tab/Shift+Tabchange level,Enteron an empty item leaves the list (feat(editor): continue a Markdown list when Enter is pressed inside one #636); the three list chords (feat(shortcuts): Mod+K inserts a link, and the table verbs move off the chord #652).Tab/Shift+Tabbetween cells,Mod+Enterrows,Mod+Shift+C/Mod+Shift+Backspacecolumns,Mod+Alt+Tto insert one (feat(editor): add and remove table rows and columns without editing pipes by hand #645, feat(shortcuts): keys for the two column verbs, and a better rule for why #653).Mod+K(feat(shortcuts): Mod+K inserts a link, and the table verbs move off the chord #652).Every key was read out of
Editor.svelterather than out of a PR description — #645'sMod+K TandMod+K Cwere superseded by #653 two PRs later, so the descriptions would have documented a keymap that was two days stale.That file carries no issue numbers, no history and no defence of a decision in its 500 lines; where it does give a reason — the three deliberate incompatibilities — the reason tells the reader what to write instead. Two sentences of mine argued the design at the reader (that four other editors use
Mod+K; why deleting a row has no chord while deleting a column does) and came back out. Both language versions carry the same additions.🤖 Generated with Claude Code