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

docs: update link to libp2p configuration options in README (through … #104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RenatoPerotti
Copy link

…index.ts)

Title

Description

Notes & open questions

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@RenatoPerotti RenatoPerotti requested a review from a team as a code owner August 30, 2024 00:48
@2color
Copy link
Member

2color commented Aug 30, 2024

Thanks! can you please also run the build so that the README is also regenerated?

@RenatoPerotti
Copy link
Author

RenatoPerotti commented Sep 1, 2024

I tried running (in Actions tab) by clicking "test & maybe release" but this does not seem to build a README. I see a "pages-build-deployment" here in the Actions tab but this is not available in my fork. Sorry but this is new for me, hope to be still at help :)

@2color
Copy link
Member

2color commented Sep 23, 2024

You need to run the build locally so that it generates the README and then commit it, not in GitHub Actions

@@ -90,7 +90,7 @@
*
* The [helia](https://www.npmjs.com/package/helia) module is configured with a libp2p node that is suited for decentralized applications, alternatively [@helia/http](https://www.npmjs.com/package/@helia/http) is available which uses HTTP gateways for all network operations.
*
* You can see variations of Helia and js-libp2p configuration options at <https://helia.io/interfaces/helia.index.HeliaInit.html>.
* You can see variations of Helia and js-libp2p configuration options at <https://helia.io/interfaces/helia.HeliaInit.html>.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* You can see variations of Helia and js-libp2p configuration options at <https://helia.io/interfaces/helia.HeliaInit.html>.
* You can see variations of Helia and js-libp2p configuration options at <https://ipfs.github.io/helia/interfaces/helia.HeliaInit.html>.

api docs have moved to ipfs.github.io/helia

@SgtPooki
Copy link
Member

SgtPooki commented Feb 5, 2025

after making changes to the code that is used to generate the readme, you have to run npm run docs to update the readme, and then add both the index and README file changes in your commit.

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

Successfully merging this pull request may close these issues.

3 participants