Skip to content

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

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-decorators 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, in the same layout as the dms-* modules.

What

  • .github/readme/strip.svg comes from antelopejs-readme-strip --kind interface --name database-decorators. It carries the label INTERFACE · DATABASE DECORATORS and is the README's first line, linking to AntelopeJS/antelopejs.
  • The header is centred. It holds the package name and black badges for npm, License, Discord, Docs and Star AntelopeJS. Below the badges 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, and 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 with the strip command and the table generator. On 0.5.5, antelopejs-sync also writes the managed pnpm-workspace.yaml, which antelopejs-sync --check requires.

Related issue

ANT-2103, 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
31:## Install
45:## Quick start
84:## Documentation
92:## Compatibility
106:## Contributing
116:## 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
34:## Install
48:## Quick start
87:## Documentation
95:## Compatibility
109:## Contributing
119:## Part of AntelopeJS
137:## License
$ 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 $'README.md\ndocs' --typescript-project docs/tsconfig.json
Docs: 6 files, 24 local links, 0 compatibility tables, 3 checked examples, 0 API pages; 0 failures.

The before and after screenshots of the rendered README 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 f26f1e3 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