libp2p / docs

Documentation site for the libp2p project.
https://docs.libp2p.io/
Other
62 stars 89 forks source link

add links to particular examples #182

Closed momack2 closed 2 years ago

momack2 commented 2 years ago

https://docs.libp2p.io/examples/

Add sub-links to each example for each of Go, JS, and Rust - and turn those into overall headings for the examples within their domains

SincerelyBrittany commented 2 years ago

Hi @momack2 can I work on this issue? It is just adding sublinks in the side bar right? Similar to the tutorials shown here?

Screen Shot 2022-09-06 at 6 23 39 PM
salmad3 commented 2 years ago

Already tracked in https://github.com/libp2p/docs/issues/29 & https://github.com/libp2p/docs/issues/168. We are also creating a "Guides" section to encapsulate all examples and tutorials: https://github.com/libp2p/docs/pull/174

momack2 commented 2 years ago

I think this more closely maps to #168 - but is an intermediary step before 29.

I intentionally am trying to create more broken out issues that other new contributors can take on independently and use to get involved (like Brittany!) Part of the goal of an OSS project is to create smooth onboarding pathways both for users and for contributors to get involved - like “good starter issues”.

Unless 29 is the immediate focus for libp2p docs right now, the incremental improvement of adding each example header and link into the page (not just the sidebar) would imho be a significant improvement. If that is orthogonal to future plans, feel free to adjust proposed scope here to something more reusable given longer term path.🙏

On Tue, Sep 6, 2022 at 10:58 PM Danny Salman @.***> wrote:

Already tracked in #29 https://github.com/libp2p/docs/issues/29 & #168 https://github.com/libp2p/docs/issues/168. We are also creating a "Guides" section to encapsulate all examples and tutorials: #174 https://github.com/libp2p/docs/pull/174

— Reply to this email directly, view it on GitHub https://github.com/libp2p/docs/issues/182#issuecomment-1238731507, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAEXAF74DLY7X3RFL47V2JTV47D7ZANCNFSM6AAAAAAQGDB5XY . You are receiving this because you were mentioned.Message ID: @.***>

salmad3 commented 2 years ago

Right, that makes sense, thanks @momack2!