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

ipfs in web apps guide #1970

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

ipfs in web apps guide #1970

wants to merge 19 commits into from

Conversation

2color
Copy link
Member

@2color 2color commented Dec 16, 2024

What's in this PR

  • New IPFS in web applications guide
  • Updates and corrections to the lifecycle of data in IPFS
  • Remove the outdated frameworks page and update navigation

@2color 2color marked this pull request as ready for review January 20, 2025 14:55
@2color 2color requested review from lidel and achingbrain January 20, 2025 14:55
@2color 2color requested a review from SgtPooki January 23, 2025 14:54
Copy link
Member

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

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

some comments

docs/concepts/lifecycle.md Outdated Show resolved Hide resolved
docs/how-to/ipfs-in-web-apps.md Outdated Show resolved Hide resolved
docs/how-to/ipfs-in-web-apps.md Outdated Show resolved Hide resolved

- Using the [`Verified Fetch`](https://www.npmjs.com/package/@helia/verified-fetch) library, which was modelled after the `fetch` API and returns `Response` objects, with the main difference being that it allows you to fetch data by CID, abstracting away the details of content routing, transports and retrieval. For more examples and background see the [release blog post](https://blog.ipfs.tech/verified-fetch/).
- Using the [`helia`](https://github.com/ipfs/helia/) library, which is the foundation for the `verified-fetch` library, and provides a more comprehensive and modular API for interacting with the IPFS network, beyond just retrieval.
- Using public recursive gateways, e.g. `ipfs.io` with HTTP. This is not recommended for most use cases, because it forgoes the verifiability and trustlessness enabled by content addressing. Granted, it might be the easiest way to retrieve data in a web application, but is also the most fraught with security and centralization concerns.
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to mention that our goal is to push away from public backend infrastructure like this and that we aim more toward trustless gateways?

Copy link
Member Author

Choose a reason for hiding this comment

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

We should link to the gateways page which is pretty up to date with these nuances. Also are you refering to trustless gateway providers or just recursive trustless gateways?

Copy link
Member

@SgtPooki SgtPooki Feb 4, 2025

Choose a reason for hiding this comment

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

Our team goals include moving away from recursive trustless gateways AFAIK, but we will probably always run a trustless gateway provider. I'd have to defer to Lidel/Adin for a 5-10-year plan. We don't need to mention it if it's that far ahead.

My main point was that, besides informing the readers that it's not recommended, we should also indicate that we are "tightening our purse strings" regarding hosting those services.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree completely. Just not sure if this belongs here. This information about the general shift applies to a lot of content in the docs, so maybe worthy of it's own section in the gateways page.

docs/how-to/ipfs-in-web-apps.md Outdated Show resolved Hide resolved
docs/how-to/ipfs-in-web-apps.md Show resolved Hide resolved
2color and others added 2 commits January 27, 2025 14:02
@achingbrain
Copy link
Member

Nice! Definitely prefer the "on the web" nomenclature to "in the browser", as if "the browser" was a homogenous thing rather than a collection of semi-incompatible runtimes.

* origin/main: (24 commits)
  Revert "edit problematic file"
  fix: use offical action now that pr has been merged
  edit problematic file
  fix: use forked langauge tool action
  ci: review prs with languagetool
  chore: bump versions in installation docs (#1958)
  Update docs/how-to/gateway-troubleshooting.md
  add blockchain to list of accepted words
  fix vale error
  add reprovide to accepted words
  correct dht expiration time for records
  correct dht expiration time and improve ipns docs
  fix: update pinning services
  Update merkle-dag.md
  fix: formatting
  Update docs/concepts/ipfs-implementations.md
  chore: use current-ipfs-version
  fix: lint
  docs: docker container limits
  change helia language to TS
  ...
Copy link
Member

Choose a reason for hiding this comment

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

💭 we should avoid breaking links (https://www.w3.org/Provider/Style/URI).

@2color mind adding /how-to/browser-tools-frameworks/ /docs/how-to/ipfs-in-web-apps/ to docs/.vuepress/redirects 🙏 ?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's already there

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.

4 participants