Skip to content

docs: add getting started section to examples README#5934

Merged
mergify[bot] merged 3 commits intolibp2p:masterfrom
VolodymyrBg:bg
Apr 21, 2025
Merged

docs: add getting started section to examples README#5934
mergify[bot] merged 3 commits intolibp2p:masterfrom
VolodymyrBg:bg

Conversation

@VolodymyrBg
Copy link
Contributor

@VolodymyrBg VolodymyrBg commented Mar 18, 2025

This PR improves the documentation in the examples/README.md file by adding proper content to the "Getting started" section that was previously empty.

Changes

  • Added instructions on how to run examples using Cargo
  • Mentioned that each example has its own README with specific instructions
  • Noted that most examples require multiple instances for P2P communication
  • Listed prerequisites for running the examples

Motivation

New users looking to try out rust-libp2p examples would benefit from clear instructions on how to get started. The empty section could be confusing and might discourage them from exploring the examples. This change makes the documentation more user-friendly and reduces the barrier to entry for people wanting to learn about libp2p.

Related Issues

N/A

Testing

No testing required as this is a documentation-only change.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • A changelog entry has been made in the appropriate crates

Copy link
Member

@elenaf9 elenaf9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VolodymyrBg!

@VolodymyrBg
Copy link
Contributor Author

VolodymyrBg commented Mar 18, 2025

@elenaf9 Thanks, can it be merged, please?

Copy link
Member

@jxs jxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this is yet another airdrop farming PR, specially after the demanding to be merged.

@VolodymyrBg
Copy link
Contributor Author

@jxs Hi, my pull request was approved what means it was useful as far as I understand. So I politely asked if the PR could be merged. I didn't demand to merge this PR. Sorry if something went wrong

@VolodymyrBg VolodymyrBg requested review from elenaf9 and jxs April 7, 2025 14:19
@mergify mergify bot merged commit bd49632 into libp2p:master Apr 21, 2025
71 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants