Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #86
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
Why
Visitors to the
interface-databaseREADME should see on the first screen that the package belongs to AntelopeJS. From there they should be able to star AntelopeJS and find the other contracts and providers. This PR gives the README the framework README shape that ANT-2094 approved, which is the layout thedms-*modules already use.What
.github/readme/strip.svgcomes fromantelopejs-readme-strip --kind interface --name database. It carries the labelINTERFACE · DATABASE, opens the README, and links toAntelopeJS/antelopejs.Star AntelopeJS. Below them are the GitHub description in bold and the lineDocumentation · Implementations · All interfaces and providers.Part of [AntelopeJS]… Used by…line is removed. A new## Part of AntelopeJSsection before## Licensereplaces it.## Part of AntelopeJSholds theantelopejs-framework-modulestable, whichantelopejs-syncgenerates.@antelopejs/tooling-configsgoes from^0.5.1to^0.5.5, the release that has the strip command and the table generator.antelopejs-syncalso adds the managedallowBuildsentry topnpm-workspace.yaml. Without it,antelopejs-sync --checkreports drift on 0.5.5. The@antelopejs/mongodboverride is unchanged.Related issue
ANT-2102, a subtask of ANT-2094.
Verification
Before, on
origin/main:After, on this branch:
The README docs check (links and type-checked samples) runs in CI through
docs-files. The rendered before and after screenshots are in the task thread.Checklist