Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #17
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
interfacesREADME gets the framework README shape approved in ANT-2094. A visitor sees on the first screen that the registry belongs to AntelopeJS, can star AntelopeJS, and can find the other contracts and providers.What changes
.github/readme/strip.svgis the first line and links toAntelopeJS/antelopejs.antelopejs-readme-strip --kind tooling --name interface-registryfrom@antelopejs/tooling-configs0.5.5 wrote it, and its label readsTOOLING · INTERFACE REGISTRY.Star AntelopeJS, the GitHub description in bold, and the links line.Part of [AntelopeJS]… Built by…line is removed.## Part of AntelopeJS(one sentence) now comes after Contributing, and## Licensestays last.This repo has no
package.json. Tooling READMEs carry the sentence and not the generated framework table, so there is nothing forantelopejs-syncto fill. The strip came fromnpx -p @antelopejs/tooling-configs@0.5.5, and no dependency was added.Proof
The docs check from
.github/workflows/docs.yml(tooling-configs/actions/docsat310e3d8), run locally on this branch:The new local link is
./.github/readme/strip.svg, and it resolves.