Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #65
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
interface-authREADME adopts the framework README shape approved in ANT-2094, so a visitor sees on the first screen that the package is part of AntelopeJS, can star AntelopeJS, and can reach the other contracts and providers.What changes
.github/readme/strip.svg, written bynpx antelopejs-readme-strip --kind interface --name auth, opens the README and links toAntelopeJS/antelopejs.Star AntelopeJS, the GitHub description in bold, and the links line (Documentation · Implementations · All interfaces and providers).Part of [AntelopeJS]… Built by…line is replaced by a closing## Part of AntelopeJSsection before## License.## Part of AntelopeJSholds theantelopejs-framework-modulestable, generated byantelopejs-sync.@antelopejs/tooling-configsgoes from^0.5.1to^0.5.5, which ships the strip command and the table generator.antelopejs-syncalso addsallowBuilds: lefthook: falsetopnpm-workspace.yaml.Proof
Before, on
origin/main:After:
Before and after screenshots of the rendered README are in the agent thread.