docs(gossipsub): convert README to generated format - #3566
Open
Patrick-Ehimen wants to merge 1 commit into
Open
Conversation
packages/gossipsub/README.md was still the original hand-written ChainSafe README and had drifted from the rest of the monorepo: outdated ES-2017/node-10.x badges, a stale "Lead Maintainer" TOC entry, an API link to the archived js-libp2p-interfaces repo, and a "MIT © ChainSafe Systems" footer. Add a @packageDocumentation block to src/index.ts (matching packages/floodsub) so the README can be regenerated by `npm run docs`. Along the way, fix the package's license field, which was set to plain "Apache-2.0" instead of the monorepo-standard "Apache-2.0 OR MIT" - this is what caused the README's license section to drift in the first place - and add the missing LICENSE-APACHE, LICENSE-MIT and CODE_OF_CONDUCT.md files that every other package in the monorepo already carries. Fixes libp2p#3517
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
1 participant
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
@packageDocumentationblock topackages/gossipsub/src/index.tsso the README can be regenerated bynpm run docs, matchingpackages/floodsubpackages/gossipsub/README.md: drop outdated ES-2017/node-10.x badges, dead "Lead Maintainer" TOC entry, and the archivedjs-libp2p-interfacesAPI linklicensefield (Apache-2.0→Apache-2.0 OR MIT) and add the missingLICENSE-APACHE,LICENSE-MIT,CODE_OF_CONDUCT.mdfiles, which is what caused the README'sMIT © ChainSafe SystemsfooterFixes #3517
Test plan
aegir lintpasses forpackages/gossipsubnpm run docsfrom repo root to confirm generated README matches exactly (requires building sibling workspace packages, not run in this environment)