Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #122
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.
Summary
A visitor to this README should see on the first screen that the package belongs to AntelopeJS, be able to star AntelopeJS, and find the other contracts and providers. This PR gives the README the framework shape approved in ANT-2094, the same shape as the
dms-*READMEs in the framework blue..github/readme/strip.svg, labelledINTERFACE · DATA APIand written byantelopejs-readme-strip --kind interface --name data-api. It links toAntelopeJS/antelopejs.Star AntelopeJS, the GitHub description in bold, and the lineDocumentation · Implementations · All interfaces and providers.Implementationspoints to the README's own## Implementationssection, which names the modules that implement the interfaces this package builds on.## Part of AntelopeJSand## Licensenow close the README. The oldPart of [AntelopeJS]… Used by [AntelopeJS DMS]…line is gone.## Part of AntelopeJSholds theantelopejs-framework-modulestable thatantelopejs-syncgenerates, withinterface-data-apiin bold.@antelopejs/tooling-configsgoes from^0.5.1to^0.5.5, the release with the generator and the strip command. Sync also writes the managedpnpm-workspace.yaml.Related issue
ANT-2101, a subtask of ANT-2094.
Verification
antelopejs-sync --checkwith tooling-configs 0.5.5, before (base files) and after:pnpm run checks:Docs check (
tooling-configsv0.0.9,actions/docs/check.mjs --files README.md docs --typescript-project docs/tsconfig.json), before and after:Checklist