Repository navigation
docs: pass the subscriptions interface docs to the docs standard - #19
Merged
Merged
Conversation
Upd4ting
marked this pull request as ready for review
November 3, 2026 02:12
…n the capability matrix
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.
Why
Goal: finish the AntelopeJS docs rewrite. Every TypeScript example compiles against its repo's own source, hand-written version prose is gone, and the W1-W5 docs standard ships. This is the W4 pass for interface-subscriptions (outer-loop#35, decision 11 item 5). It brings
README.mdanddocs/to the Docs standard, in the shape of AntelopeJS/dmspackages/dms/docs, and turns standard mode on so CI keeps them there. Precedent: interface-api#71.Summary
package.json "antelopeJs": { "test": ..., "skills": [...], + "docs": { "standard": true } } README.md, docs/*.md (5 pages) + frontmatter title, description, mode (body H1 moved into title) ~ sentence-case headings, no dashes, unslop + technical-writing applied ~ claims checked against src/ and the implementations (stripe, payment-subscriptions) + README badges marked illustrationNo page was split, merged, renamed or moved, and no section, table row or example was dropped. Each docs page lost only its body H1, which moved into
title; no other heading's words changed, so no slug changed. Fences stay at 12. The wiring example in4.implementing.mdis no longer afragment: it declares each call astypeof subscriptions.X, so CI compiles it (checked examples 8 to 9).Modes: introduction explanation, subscriptions reference, events reference, implementing how-to, provider capability matrix reference.
Claims corrected against the source
@antelopejs/payment-subscriptions, whichretryDelaysMschanges (payment-subscriptionssrc/config.ts:33-38,68).SubscriptionNotFoundErroris also raised for an identifier that cannot be parsed (src/errors.ts:23-26).MAX_PORTABLE_PERIOD_DAYS(366 days) (src/types.ts:53).vendorDatais its own renewal state (reconciliationRequired,attemptStartedAt,attemptReplayUntil,phase), not absent (payment-subscriptionssrc/view.ts:6-11).@antelopejs/striperuns its conformance suite against Stripe test mode, not live Stripe (stripesrc/test/antelope.test.ts).ProviderScheduleinterface (payment-subscriptionssrc/schedule.ts:13)..nvmrcandpackageManager.Evidence
checkDocsin standard mode, Vale 3.26.0):files=6 examples=8 failures=53.files=6 examples=9 failures=0.VALE_BINset: exit 0. Not rerun on the fix commit 2f548eb; the verifier reran it on 879d966.pnpm run checkson 2f548eb withGITHUB_BASE_REF=campaign/integration:Checks: 8 passed, 0 failed.nuxt devinsites/interfaces,INTERFACES_DOCS_LOCAL=file-storage=<clone>). Every page answers 200 and no page renders{#.pages=6 links=2 anchored=1 broken=1: the one break is2.subscriptions.md's link to../README.md#quick-start, unchanged from the base. It works on GitHub; the site does not render the README.AntelopeJS/tooling-configs/actions/docs@dab0aea28840981138795aca32381e7fa8ac8d1binstalled Vale (standard mode on) and printedDocs: 6 files, 17 local links, 1 compatibility tables, 9 checked examples, 0 API pages; 0 failures.Merge danger
Door: two-way. Docs and one package.json key. A revert restores the old pages and turns standard mode off.
Blast radius: docs. From here on, every interface-subscriptions PR that touches README.md or
docs/must pass Vale and the standard checks in CI.Attention
skills/is outside a docs PR's files and was not checked.