Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #109
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-apiREADME adopts the AntelopeJS framework README shape (ANT-2094), so a visitor sees on the first screen that the package is part of AntelopeJS, can star AntelopeJS, and can find the other contracts and providers. Task: ANT-2098.What changes
.github/readme/strip.svg: written bynpx antelopejs-readme-strip --kind interface --name api(labelINTERFACE · API). It is the README's first line and links toAntelopeJS/antelopejs.Star AntelopeJS, the GitHub description in bold, and the links lineDocumentation · Implementations · All interfaces and providers.Part of [AntelopeJS]… Used by…line is gone.## Part of AntelopeJS(one sentence plus the generatedantelopejs-framework-modulestable), and## License.@antelopejs/tooling-configsgoes from^0.5.1to^0.5.5, which ships the strip command and the table generator.antelopejs-syncfilled the table and added the pack-managedallowBuilds: lefthook: falsetopnpm-workspace.yaml.Proof
Before,
antelopejs-sync --checkat 0.5.1 had no table generator and the README held no markers. After:Before and after screenshots of the rendered README are in the task thread.