Repository navigation
Publish extension-mermaid with the 2.2.0 family release and draft the launch posts #531
Copy link
Copy link
Closed
Labels
ExtensiondocumentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Part of #521. Depends on #530. Read the tracker first: its §Shared contract binds this issue. Work on main.
Summary
Release the sixth package with the family at 2.2.0, then prepare the launch that promotes Pele and credits its author (ruling 9).
Rulings: 8, 9, 12 (#521 §Maintainer rulings). The pad feature runs in production from workspace:* source before this release.
Current behaviour
- After Run the Mermaid quality pass and ship gates #530, the package is built and gated but not on npm. Three docs say "
extension-mermaidis not on npm yet".
Files and interfaces
Files
- Modify:
README.md,extensions/README.md,context7.json(remove the "not on npm yet" sentences); the rootCHANGELOG.md(the family count);extensions/extension-mermaid/CHANGELOG.md(the## [2.2.0]entry). - The
release-productskill changes the other release files (versions, the other CHANGELOGs, the release note, the banner,docs/DEMO.md). - Create, gitignored:
REPO/Notes/local-docs/<date>-mermaid-launch-drafts.md.
Interfaces
- Consumes: the green Run the Mermaid quality pass and ship gates #530 verdicts, the README Quickstart and credit line (Write the extension-mermaid README, docs, assets and StackBlitz example #526), the
starterrow p95 (Measure Pele render time on a phone and set the default diagram limits #522 comment), the hero GIF and preview PNGs (Write the extension-mermaid README, docs, assets and StackBlitz example #526).
Implementation steps
The maintainer runs every publish, push, tag and post. An agent prepares files and checks, and stops at the Review checkpoint.
- Step 1: Check Pele since the pin. Run
curl -s https://registry.npmjs.org/pele | jq -r '.["dist-tags"].latest'.- If it is still
1.6.0, record that and go on. - If it is a newer
1.6.x, raise the rootoverridesentry to it, runbun installandbun run testinPKG, and check thatbun.lockholds onepeleversion. Then rerun Run the Mermaid quality pass and ship gates #530 Steps 5-7 (includingcheck:ciandmake build-prod-ci), becausebun.lockchanged after its verdict. - If it is
1.7.0or later, read each newer release onhttps://github.com/obsidianmd/pele/releases. Then rerun the d.ts greps ([Tracking] Mermaid diagrams in docs.plus through a headless Pele extension #521 §Global constraints → Pele) andbun run testinPKG. - Expected: the latest is
1.6.x, or each newer release lists no breaking change and both checks pass.
- If it is still
- Step 2: Prepare the release text.
- Remove the sentence "
extension-mermaidis not on npm yet; it publishes with the next family release." fromREADME.md,extensions/README.mdandcontext7.json. Check:git -C REPO grep -n "not on npm yet" -- README.md extensions/README.md context7.jsonprints nothing. - In the root
CHANGELOG.md, change "The five@docs.plus/extension-*packages keep their ownCHANGELOG.mdfiles" to "The six". - In
extensions/extension-mermaid/CHANGELOG.md, replace## [Unreleased]with a hand-written## [2.2.0]and a### Highlightssection (RELEASE_POLICY.md§CHANGELOG style guide). Never generate it from commit subjects.
- Remove the sentence "
- Step 3: The maintainer runs the release. Use the
release-productskill (.cursor/skills/release-product/SKILL.md), with the extensions publishing at 2.2.0.- Keep the hand-written mermaid
## [2.2.0]entry from Step 2; do not let the skill replace it. - The skill's draft pass adds a live diagram section to
docs/DEMO.md. - Its readiness step runs
bun run release:family --dry-run. The other five packages are intended no-ops unless they gain source changes first, so override the skill twice: run the dry run asbun run release:family --dry-run --allow-noop, and in its Ship step 4 runbun run release:family --allow-noop. A preflight failure that names exactly those five siblings, without the flag, is expected. Before the commit, only the clean-tree and npm-login checks may fail. - Then follow the skill's §Ship steps.
bun publishruns per package through the Chrome passkey, andrelease:familyonly tags. - Check:
curl -s https://registry.npmjs.org/@docs.plus%2fextension-mermaid | jq -r '.["dist-tags"].latest'prints2.2.0.
- Keep the hand-written mermaid
- Step 4: Draft the launch posts. Write
REPO/Notes/local-docs/<date>-mermaid-launch-drafts.md. Its first line after the H1 reads: "Drafts only. The maintainer posts after the 2.2.0 npm publish."- Rules for every post: lead with the link; one number per post; code only as an image; upload media, never hotlink it. Fetch https://pele.run with WebFetch, and keep each Pele number only beside its source sentence. Our own number is the
starterrow p95, with its method. Use the credit line from [Tracking] Mermaid diagrams in docs.plus through a headless Pele extension #521 §Pele promotion verbatim. - X thread: 3 to 5 posts, each 280 characters or fewer (check each with
wc -m). Post 1 leads with the npm link. It quote-posts kepano's Pele launch post, https://x.com/kepano/status/2111472054293913749, and tags@kepanoand@obsdmd. Attach the hero GIF (extensions/extension-mermaid/assets/demo-light.gif) and a preview PNG. - "Pele in use" request: a draft issue for
https://github.com/obsidianmd/pele. It says what docs.plus is, links the package, describes the pad use, and carries the credit line. The channel is unconfirmed: pele.run shows no way to ask for a listing. - Tiptap GitHub Discussions post, in the "Community Extensions" category. The form has these fields:
- Title:
Community Extension: @docs.plus/extension-mermaid. - Type:
Extension. - Description: a short paragraph on what it does and why Pele.
- Installation:
npm install @docs.plus/extension-mermaidfirst, then one line naming pnpm, yarn and bun, andpeleas the one runtime dependency. - Usage: the README Quickstart block, byte for byte.
- Other: links to npm, the source and https://docs.plus.
- Title:
- awesome-tiptap pull request for
https://github.com/ueberdosis/awesome-tiptap: a title, a body, and one line under "Community extensions":* [@docs.plus/extension-mermaid](https://github.com/docs-plus/docs.plus/tree/main/extensions/extension-mermaid) by [@docs-plus](https://github.com/docs-plus). Check the list order when the pull request opens. - Check:
grep -n -i "creator of obsidian\|endorse\|raw.githubusercontent" <the drafts file>prints nothing.
- Rules for every post: lead with the link; one number per post; code only as an image; upload media, never hotlink it. Fetch https://pele.run with WebFetch, and keep each Pele number only beside its source sentence. Our own number is the
- Step 5: Review checkpoint. Report the Step 1 result, the Step 2 checks, the npm version from Step 3, and the drafts file path. Stop. The maintainer posts the drafts.
Acceptance criteria
@docs.plus/extension-mermaid@2.2.0is on npm, andrelease:familycreated the six tags.- The launch drafts exist and pass the Step 4 check.
- Context7 is refreshed.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
ExtensiondocumentationImprovements or additions to documentationImprovements or additions to documentation
Activity
HMarzban commentedon Oct 21, 2026
Step 1 done: Pele is now
1.7.0, 2026-10-20npm showed
pele@1.7.0(published 2026-10-19 18:21 UTC), so the pin moved from1.6.0inaebd55866. It is deployed in3784c2c65 (build): front back.mermaidTypetorender(),parse()andPeleError, and wraps Chinese and Japanese labels between characters. No breaking change.overrides, the packagedependenciesandapps/hocuspocus.serverall say1.7.0.bun.lockholds onepele@1.7.0.0and0for the Pele names, andinsertMermaid1and1.bun test src13/13, typecheck clean, clean-room Cypress 117/117.checkDiagramssmoke test parses all 14 named types and keeps the same refusals.lazy.d.ts, theexportsmap and themaxEdgescode are the same as in1.6.0. The #529 matrix and the #522 laptop measure ran on1.6.0. So the #522 phone run measures the version that ships.HMarzban commentedon Oct 22, 2026
Shipped in docs.plus 2.2.0.
@docs.plus/extension-mermaid@2.2.0is on npm, as its first publish, together with the other five family packages at 2.2.0.@docs.plus/extension-mermaid@2.2.0points at the release commit b71a84d, the same commit asv2.2.0.