Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #13
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The
cloud-sdkREADME 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
.github/readme/strip.svgis written byantelopejs-readme-strip --kind tooling --name cloud-sdk(labelTOOLING · CLOUD SDK). It is the README's first line and links toAntelopeJS/antelopejs, with a descriptivealt.@antelopejs/cloud-sdkand@antelopejs/cloud, License, Discord (g4pFt6eXqu), Docs andStar AntelopeJS. Then the GitHub description in bold and the links line (CLI docs, SDK docs, all interfaces and providers).## Part of AntelopeJS(the framework sentence, no table, since this is tooling) and## License. Every existing section keeps its text.sdkandcliall move from^0.5.2to^0.5.5. With only the root raised, oxlint loaded two copies of the preset and failed withPlugin name 'anti-slop' is already registered, so the three stay on one version.antelopejs-syncaddedallowBuilds: lefthook: falsetopnpm-workspace.yaml. The README has no framework-table markers, so sync writes nothing into it.Two choices worth a look:
framework.antelopejs.com/docs/cloudreturns 404). The Docs badge therefore openscli/README.md, and the links line names both package READMEs.LICENSEfile; both packages declare Apache-2.0 in theirpackage.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 checkson this branch:With only the root bumped (before aligning
sdkandcli):pnpm run check:hostsexits 0 on this branch.