Skip to content

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

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 cloud-sdk README adopts the framework README shape approved in ANT-2094 (ANT-2133). A visitor sees on the first screen that the SDK and CLI are part of AntelopeJS, can star AntelopeJS, and can reach the other contracts and providers.

What

  • Strip. .github/readme/strip.svg is written by antelopejs-readme-strip --kind tooling --name cloud-sdk (label TOOLING · CLOUD SDK). It is the README's first line and links to AntelopeJS/antelopejs, with a descriptive alt.
  • Centred header. The existing title, then black badges: npm for @antelopejs/cloud-sdk and @antelopejs/cloud, License, Discord (g4pFt6eXqu), Docs and Star AntelopeJS. Then the GitHub description in bold and the links line (CLI docs, SDK docs, all interfaces and providers).
  • Closing sections. ## Part of AntelopeJS (the framework sentence, no table, since this is tooling) and ## License. Every existing section keeps its text.
  • tooling-configs 0.5.5. The root, sdk and cli all move from ^0.5.2 to ^0.5.5. With only the root raised, oxlint loaded two copies of the preset and failed with Plugin name 'anti-slop' is already registered, so the three stay on one version. antelopejs-sync added allowBuilds: lefthook: false to pnpm-workspace.yaml. The README has no framework-table markers, so sync writes nothing into it.

Two choices worth a look:

  • No cloud page exists on the framework docs site (framework.antelopejs.com/docs/cloud returns 404). The Docs badge therefore opens cli/README.md, and the links line names both package READMEs.
  • The repository has no LICENSE file; both packages declare Apache-2.0 in their package.json. The License badge links to #license, and that section says so.

Proof

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

pnpm run checks on this branch:

Checks: 11 passed, 0 failed.

With only the root bumped (before aligning sdk and cli):

[ratchet]
Unexpected token 'F', "Failed to "... is not valid JSON
Checks: 10 passed, 1 failed.

pnpm run check:hosts exits 0 on this branch.

@Upd4ting
Upd4ting merged commit e0f3e0f into main Nov 12, 2026
8 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