Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Examples section #29

Closed
yusefnapora opened this issue Mar 19, 2019 · 3 comments
Closed

Improve Examples section #29

yusefnapora opened this issue Mar 19, 2019 · 3 comments
Assignees
Labels
area:guides Tutorials, how-tos, examples, and common guides. needs thinking

Comments

@yusefnapora
Copy link
Contributor

The current examples section just links to external sources for go, js and rust.

I think there's a big opportunity to take those external examples and rework them a bit, pull them into the site, and use them as teaching tools to walk people through libp2p use cases.

I think that keeping the examples in their own repos will probably work best, since that's the easiest place to keep them up-to-date and integrated with CI.

My tentative plan is to clone the example repos as part of the build process for this site, run them through some formatting, and embed the result into the site.

For this to work well, some work needs to be done on the example repos so that they all have enough narrative & framing around them, and I need to develop the formatting / build process.

@tristanisham
Copy link

@yusefnapora I created a pull for the Go getting started example. In its current state, it won't compile. There's no mention of the necessary declaration of ctx as seen in the last two code snippets of the document.

 // The context governs the lifetime of the libp2p node.
// Cancelling it will stop the the host.
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

@p-shahi
Copy link
Member

p-shahi commented Aug 26, 2022

Reach out to other implementations (Python, Nim, Zig, etc) to be included in examples page. Will close the child tickets in favor of this one. @DannyS03 plans to combine the Tutorials and Examples section in the future, so some of this work will be addressed by that.

@p-shahi p-shahi added the P2 Medium label Aug 26, 2022
@salmad3 salmad3 assigned salmad3 and unassigned yusefnapora Aug 29, 2022
@salmad3 salmad3 moved this to 🏃‍♀️ In Progress in go-libp2p Aug 31, 2022
@salmad3 salmad3 added area:guides Tutorials, how-tos, examples, and common guides. type:enhancement Content enhancement, new feature or request. type:new page New content page needs thinking and removed enhancement type:enhancement Content enhancement, new feature or request. type:new page New content page labels Nov 23, 2022
@salmad3 salmad3 removed the P2 Medium label Jan 9, 2023
@salmad3
Copy link
Member

salmad3 commented Jan 9, 2023

After having touched on this issue (and idea) a few times in the latter half of 2022, the preference among the stewards is to keep the examples in their respective repos.

We also have a general "Guides" section now that provides guides to get started with libp2p, and it will continue to refer to the examples in each repo (for example, as mentioned here). Implementations that do not have a getting started guide will be added shortly.

As a result, let's close this and revisit if necessary.

@salmad3 salmad3 closed this as completed Jan 9, 2023
@github-project-automation github-project-automation bot moved this from 🏃‍♀️ In Progress to 🎉 Done in go-libp2p Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:guides Tutorials, how-tos, examples, and common guides. needs thinking
Projects
Archived in project
Development

No branches or pull requests

4 participants