Skip to content

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

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

Why

Visitors to the interface-database README should see on the first screen that the package belongs to AntelopeJS. From there they should be able to star AntelopeJS and find the other contracts and providers. This PR gives the README the framework README shape that ANT-2094 approved, which is the layout the dms-* modules already use.

What

  • .github/readme/strip.svg comes from antelopejs-readme-strip --kind interface --name database. It carries the label INTERFACE · DATABASE, opens the README, and links to AntelopeJS/antelopejs.
  • The header is centred. It holds the package name, then black badges for npm, License, Discord, Docs and Star AntelopeJS. Below them are the GitHub description in bold and the line Documentation · Implementations · All interfaces and providers.
  • The body sections keep their text. The Part of [AntelopeJS]… Used by… line is removed. A new ## Part of AntelopeJS section before ## License replaces it.
  • ## Part of AntelopeJS holds the antelopejs-framework-modules table, which antelopejs-sync generates.
  • @antelopejs/tooling-configs goes from ^0.5.1 to ^0.5.5, the release that has the strip command and the table generator. antelopejs-sync also adds the managed allowBuilds entry to pnpm-workspace.yaml. Without it, antelopejs-sync --check reports drift on 0.5.5. The @antelopejs/mongodb override is unchanged.

Related issue

ANT-2102, a subtask of ANT-2094.

Verification

Before, on origin/main:

$ grep -c "antelopejs-framework-modules\|strip.svg\|Star AntelopeJS" README.md
0
$ grep -n "^## " README.md
14:## What it offers
22:## Implementations
29:## Install
43:## Quick start
76:## Documentation
84:## Compatibility
96:## Contributing
106:## License

After, on this branch:

$ grep -c "antelopejs-framework-modules\|strip.svg\|Star AntelopeJS" README.md
4
$ grep -n "^## " README.md
17:## What it offers
25:## Implementations
32:## Install
46:## Quick start
79:## Documentation
87:## Compatibility
99:## Contributing
109:## Part of AntelopeJS
127:## License
$ pnpm exec antelopejs-sync --check
Guardrails are in sync.
$ pnpm run checks
Checks: 11 passed, 0 failed.

The README docs check (links and type-checked samples) runs in CI through docs-files. The rendered before and after screenshots are in the task thread.

Checklist

  • The pull request title follows Conventional Commits.
  • I added or updated tests when behavior changed. Not applicable: this PR changes only documentation.
  • I updated documentation when users or contributors are affected.
  • I documented breaking changes and migration steps. Not applicable: nothing breaks.
  • I did not include credentials or unrelated changes.

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