docs: move docs to packageDocumentation #2180
Merged
Conversation
This file contains 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
Since ageir 41.1.0 the contents of the `@packageDocumentation` tag in the `/src/index.ts` file of a given module will be copied to the README for that repo under the `About` section, so move all hand-written README data into `@pacakgeDocumentation` tags so we can keep the docs up to date in just one place.
maschad
reviewed
Nov 1, 2023
| ## Usage | ||
|
|
||
| ```Typescript | ||
| ```ts |
There was a problem hiding this comment.
You've chosen to keep the Typescript example here (in the README) but moved it to the @packageDocumentation in other instances, is this intentional?
maschad
reviewed
Nov 1, 2023
| import { createLibp2pNode } from 'libp2p' | ||
| import { kadDHT } from '@libp2p/kad-dht' | ||
|
|
||
| const node = await createLibp2pNode({ |
maschad
reviewed
Nov 1, 2023
There was a problem hiding this comment.
My main aversion to this is that we lose the ability to lint the TS examples as the typescript-docs-verifier runs on the markdown, I suppose this could be run when the docs are being generated from the packageDocumentation though.
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.
Since ageir 41.1.0 the contents of the
@packageDocumentationtag in the/src/index.tsfile of a given module will be copied to the README for that repo under theAboutsection, so move all hand-written README data into@pacakgeDocumentationtags so we can keep the docs up to date in just one place.