Skip to content

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

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

Summary

A visitor to this README should see on the first screen that the package belongs to AntelopeJS, be able to star AntelopeJS, and find the other contracts and providers. This PR gives the README the framework shape approved in ANT-2094, the same shape as the dms-* READMEs in the framework blue.

  • The README opens with .github/readme/strip.svg, labelled INTERFACE · DATA API and written by antelopejs-readme-strip --kind interface --name data-api. It links to AntelopeJS/antelopejs.
  • A centred header holds the package name, the black badges with Star AntelopeJS, the GitHub description in bold, and the line Documentation · Implementations · All interfaces and providers. Implementations points to the README's own ## Implementations section, which names the modules that implement the interfaces this package builds on.
  • The section text is unchanged and the sections already ended with Documentation, Compatibility and Contributing. ## Part of AntelopeJS and ## License now close the README. The old Part of [AntelopeJS]… Used by [AntelopeJS DMS]… line is gone.
  • ## Part of AntelopeJS holds the antelopejs-framework-modules table that antelopejs-sync generates, with interface-data-api in bold.
  • @antelopejs/tooling-configs goes from ^0.5.1 to ^0.5.5, the release with the generator and the strip command. Sync also writes the managed pnpm-workspace.yaml.

Related issue

ANT-2101, a subtask of ANT-2094.

Verification

antelopejs-sync --check with tooling-configs 0.5.5, before (base files) and after:

Drift: pnpm-workspace.yaml; run antelopejs-sync
Guardrails are in sync.

pnpm run checks:

Checks: 11 passed, 0 failed.

Docs check (tooling-configs v0.0.9, actions/docs/check.mjs --files README.md docs --typescript-project docs/tsconfig.json), before and after:

Docs: 12 files, 61 local links, 0 compatibility tables, 7 checked examples, 0 API pages; 0 failures.
Docs: 12 files, 63 local links, 0 compatibility tables, 7 checked examples, 0 API pages; 0 failures.

Checklist

  • The pull request title follows Conventional Commits.
  • I added or updated tests when behavior changed. No behaviour changed.
  • I updated documentation when users or contributors are affected.
  • I documented breaking changes and migration steps. None.
  • I did not include credentials or unrelated changes.

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