Repository navigation
docs(readme): adopt the AntelopeJS framework README style - #41
Merged
Merged
Conversation
Upd4ting
force-pushed
the
docs/framework-readme
branch
from
November 12, 2026 13:40
faf8433 to
d66cb10
Compare
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
template-module-typescriptREADME adopts the framework README shape approved in ANT-2094. A visitor sees on the first screen that the template is part of AntelopeJS, can star AntelopeJS, and finds the other contracts and providers.What changes
@antelopejs/tooling-configsgoes from^0.5.4to^0.5.5, which ships the README strip command..github/readme/strip.svgis written byantelopejs-readme-strip --kind template --name module-typescript(labelTEMPLATE · MODULE TYPESCRIPT) and opens the README, linking toAntelopeJS/antelopejs.Star AntelopeJS, the GitHub description in bold, and the links line.## Part of AntelopeJSsection with the one-sentence framework pitch sits between## Contributingand## License. Templates carry no framework modules table, so the README has noantelopejs-framework-modulesmarkers andantelopejs-syncwrites nothing into it.Since this repository is the template
ajs module initcopies, a new module also starts with this README and strip. Renaming them is part of making the module yours, like the package name.Proof
Before and after screenshots of the rendered README are in the task thread.