Skip to content

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

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 interfaces README gets the framework README shape approved in ANT-2094. A visitor sees on the first screen that the registry belongs to AntelopeJS, can star AntelopeJS, and can find the other contracts and providers.

What changes

  • .github/readme/strip.svg is the first line and links to AntelopeJS/antelopejs. antelopejs-readme-strip --kind tooling --name interface-registry from @antelopejs/tooling-configs 0.5.5 wrote it, and its label reads TOOLING · INTERFACE REGISTRY.
  • The header is centred: the title, the black badges plus Star AntelopeJS, the GitHub description in bold, and the links line.
  • The old Part of [AntelopeJS]… Built by… line is removed. ## Part of AntelopeJS (one sentence) now comes after Contributing, and ## License stays last.
  • The text of the other sections is unchanged.

This repo has no package.json. Tooling READMEs carry the sentence and not the generated framework table, so there is nothing for antelopejs-sync to fill. The strip came from npx -p @antelopejs/tooling-configs@0.5.5, and no dependency was added.

Proof

The docs check from .github/workflows/docs.yml (tooling-configs/actions/docs at 310e3d8), run locally on this branch:

$ node actions/docs/check.mjs --files README.md
Docs: 1 files, 4 local links, 0 compatibility tables, 0 checked examples, 0 API pages; 0 failures.

The new local link is ./.github/readme/strip.svg, and it resolves.

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