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

Suggestion to Include a Practical Example of Interacting with Lightning Network Nodes Using Polar as a Development Environment in the Documentation #945

Open
kleyberthsantos opened this issue Jul 16, 2024 · 2 comments · May be fixed by #953
Labels
documentation Improvements or additions to documentation

Comments

@kleyberthsantos
Copy link

Hello,

I would like to suggest the inclusion of a link to an example project in Polar's documentation. This project demonstrates how to interact with Lightning Network nodes using Polar as a development environment. I believe it would be a valuable resource for new users seeking practical usage examples.

Here is the link to the project: lightning-polar-ejemplo

Additionally, this example is provided in Spanish to support the Hispanic community with documentation in their native language.

Thank you for considering this suggestion!

Best regards,
Kley

@kleyberthsantos kleyberthsantos added the enhancement New feature or request label Jul 16, 2024
@jamaljsr
Copy link
Owner

Thank you for the suggestion. I am ok with adding a link to examples in the README.

We currently have an existing example in this repo, though it may need to be updated. I think it may make sense to extract that out into a separate repo and link to that one as well.

@jamaljsr jamaljsr added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jul 18, 2024
@kleyberthsantos
Copy link
Author

kleyberthsantos commented Jul 19, 2024

Hello,

I have created a new pull request to add the suggested usage example to Polar's documentation. Here is the link for review:

This example is provided in Spanish to support the Hispanic community.

Thank you for considering this suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants