libp2p / libp2p/docs

Create getting started guide for nim-libp2p

Open
#245 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:guides P2 type:new page
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

Done Criteria

  • Tutorial introduction: Ping application
  • Prerequisites
    • Install Nim
    • Create an empty project
    • Install nim-libp2p
  • Setup
    • Create new file "test.nim"
    • Introduce chronos.
    • Import dependencies
      • Import chronos
      • Import libp2p and ping protocol
  • libp2p procedures
    • Gentle introduction to nim procedures
    • Create ping procedure
  • Run the ping protocol

Why Important

  • Showcases how users can get started with nim-libp2p.
  • Follows the other getting started tutorials on the docs.

Notes

  • Link to status.im tutorials and existing examples.

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 by reading the existing getting-started tutorials in the docs, then compare the status.im tutorials and existing examples mentioned in the issue. Build the guide around a new test.nim Ping application, covering Nim installation, project setup, nim-libp2p and chronos imports, procedures, and running the ping protocol. Done means every checklist item is covered and the tutorial is linked from the docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
nim
Domain
documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.