Skip to content

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

Merged
Upd4ting merged 1 commit into
mainfrom
docs/framework-readme
Nov 12, 2026
Merged

Upd4ting merged 1 commit into
mainfrom
docs/framework-readme

Conversation

@Upd4ting

Copy link
Copy Markdown
Member

Why

The interface-auth README adopts the framework README shape approved in ANT-2094, so a visitor sees on the first screen that the package is part of AntelopeJS, can star AntelopeJS, and can reach the other contracts and providers.

What changes

  • .github/readme/strip.svg, written by npx antelopejs-readme-strip --kind interface --name auth, opens the README and links to AntelopeJS/antelopejs.
  • A 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 body keeps its sections and text. The Part of [AntelopeJS]… Built by… line is replaced by a closing ## Part of AntelopeJS section before ## License.
  • ## Part of AntelopeJS holds the antelopejs-framework-modules table, generated by antelopejs-sync.
  • @antelopejs/tooling-configs goes from ^0.5.1 to ^0.5.5, which ships the strip command and the table generator. antelopejs-sync also adds allowBuilds: lefthook: false to pnpm-workspace.yaml.

Proof

Before, on origin/main:

$ grep -c antelopejs-framework-modules README.md
0

After:

$ pnpm exec antelopejs-sync --check
Guardrails are in sync.
$ pnpm run checks
Checks: 11 passed, 0 failed.
$ node <tooling-configs@v0.0.9>/actions/docs/check.mjs --files "$(printf 'README.md\ndocs')" --typescript-project docs/tsconfig.json
Docs: 5 files, 21 local links, 0 compatibility tables, 3 checked examples, 0 API pages; 0 failures.

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

@Upd4ting
Upd4ting merged commit 0262537 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