Skip to content

docs: pass the subscriptions interface docs to the docs standard - #19

Merged
Upd4ting merged 3 commits into
campaign/integrationfrom
docs/w4-pass
Nov 4, 2026
Merged

Upd4ting merged 3 commits into
campaign/integrationfrom
docs/w4-pass

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

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.md and docs/ to the Docs standard, in the shape of AntelopeJS/dms packages/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 illustration

No 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 in 4.implementing.md is no longer a fragment: it declares each call as typeof 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

  • The fallback retry policy (one, three and seven days) is the default of @antelopejs/payment-subscriptions, which retryDelaysMs changes (payment-subscriptions src/config.ts:33-38,68).
  • SubscriptionNotFoundError is also raised for an identifier that cannot be parsed (src/errors.ts:23-26).
  • "Periods up to a year" now names MAX_PORTABLE_PERIOD_DAYS (366 days) (src/types.ts:53).
  • The fallback's vendorData is its own renewal state (reconciliationRequired, attemptStartedAt, attemptReplayUntil, phase), not absent (payment-subscriptions src/view.ts:6-11).
  • @antelopejs/stripe runs its conformance suite against Stripe test mode, not live Stripe (stripe src/test/antelope.test.ts).
  • The fallback's schedule seam is the ProviderSchedule interface (payment-subscriptions src/schedule.ts:13).
  • Version prose: "Use Node.js 24 and pnpm 10.6.5" now points at .nvmrc and packageManager.

Evidence

  • Before (campaign/integration f4d7e5f, tooling-configs dab0aea checkDocs in standard mode, Vale 3.26.0): files=6 examples=8 failures=53.
  • After (head 2f548eb): files=6 examples=9 failures=0.
  • docs-measure on 879d966 with VALE_BIN set: exit 0. Not rerun on the fix commit 2f548eb; the verifier reran it on 879d966.
  • pnpm run checks on 2f548eb with GITHUB_BASE_REF=campaign/integration: Checks: 8 passed, 0 failed.
  • Rendered anchors: interface-subscriptions has no entry on the interfaces site, so its pages were rendered through the same pipeline under a borrowed slug (antelope-web campaign/integration a8f40a6, nuxt dev in sites/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 is 2.subscriptions.md's link to ../README.md#quick-start, unchanged from the base. It works on GitHub; the site does not render the README.
  • CI run (on 879d966; the fix commit 2f548eb has its own run) 41557780460: every job passed or was skipped. The docs step AntelopeJS/tooling-configs/actions/docs@dab0aea28840981138795aca32381e7fa8ac8d1b installed Vale (standard mode on) and printed Docs: 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

  • The capability matrix says "PayPal and Mollie are plans" and "This is not verified against Mollie". The internal AntelopeJS mollie module already implements this interface, so both lines are stale, but updating them would describe an internal module in public docs. Left as written for Antony to decide.
  • Kept: "checked against the documentation of each provider on 2026-09-18" on the matrix page. It dates the provider research and makes no package compatibility claim.
  • Not confirmed: the quoted Mollie, Adyen, Checkout.com and Mangopay documentation text.
  • skills/ is outside a docs PR's files and was not checked.

@Upd4ting
Upd4ting marked this pull request as ready for review November 3, 2026 02:12
@Upd4ting
Upd4ting merged commit f54532c into campaign/integration Nov 4, 2026
7 checks passed
@Upd4ting
Upd4ting deleted the docs/w4-pass branch November 4, 2026 14:37
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.

1 participant