Skip to content

docs(readme): adopt the AntelopeJS framework README style - #109

Merged
Upd4ting merged 2 commits into
mainfrom
docs/framework-readme
Nov 12, 2026
Merged

Upd4ting merged 2 commits into
mainfrom
docs/framework-readme

Conversation

@Upd4ting

Copy link
Copy Markdown
Member

Why

The interface-api README adopts the AntelopeJS framework README shape (ANT-2094), so a visitor sees on the first screen that the package is part of AntelopeJS, can star AntelopeJS, and can find the other contracts and providers. Task: ANT-2098.

What changes

  • .github/readme/strip.svg: written by npx antelopejs-readme-strip --kind interface --name api (label INTERFACE · API). It is the README's first line and links to AntelopeJS/antelopejs.
  • Centred header: the package name, the black badges plus Star AntelopeJS, the GitHub description in bold, and the links line Documentation · Implementations · All interfaces and providers.
  • The intro paragraph is replaced by the bold GitHub description, which says the same thing. The old Part of [AntelopeJS]… Used by… line is gone.
  • Body sections keep their text. They end with Documentation, Compatibility, Contributing, ## Part of AntelopeJS (one sentence plus the generated antelopejs-framework-modules table), and ## License.
  • @antelopejs/tooling-configs goes from ^0.5.1 to ^0.5.5, which ships the strip command and the table generator. antelopejs-sync filled the table and added the pack-managed allowBuilds: lefthook: false to pnpm-workspace.yaml.

Proof

Before, antelopejs-sync --check at 0.5.1 had no table generator and the README held no markers. After:

$ pnpm exec antelopejs-sync --check
Guardrails are in sync.
$ pnpm run checks
Checks: 11 passed, 0 failed.

Before and after screenshots of the rendered README are in the task thread.

@Upd4ting
Upd4ting merged commit 5b7a3b9 into main Nov 12, 2026
8 checks passed
@Upd4ting
Upd4ting deleted the docs/framework-readme branch November 12, 2026 14:05
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