libp2p / libp2p/docs

Revisit muxer overview text

Open
#313 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

          I feel like there's a lot one could do to improve this text, but I'm fine with merging this as is.

Originally posted by @marten-seemann in https://github.com/libp2p/docs/pull/270#pullrequestreview-1286321505

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the overview text and the referenced pull request #270 and review comment to locate the muxer documentation. Read the surrounding documentation and revision history to determine the intended scope. Done means the overview has an agreed, clearer revision and the documentation review passes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.