docs: Create general profiles for different types of libp2p configurations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 546
- Avg merge
- 8h 18m
- Merged PRs (30d)
- 16
Description
Similar to the [js-ipfs profiles](https://github.com/ipfs/js-ipfs/blob/bf1bc8b18d750d5591bdd575a6d0f4c067d61d0a/docs/CONFIG.md?plain=1#L39) we should have different profiles in the https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md docs that outline how a user can potentially configure their nodes for different scenarios. Some examples could be:
- node
- browser
- LAN network e.g. for mDNS
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing doc/CONFIGURATION.md with the linked js-ipfs docs/CONFIG.md profile examples. Define general configuration profiles for node, browser, and LAN/mDNS scenarios, with enough settings and explanation for users to choose an appropriate setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100