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: add FAQ #85

Merged
merged 2 commits into from
Apr 12, 2023
Merged

docs: add FAQ #85

merged 2 commits into from
Apr 12, 2023

Conversation

achingbrain
Copy link
Member

Refs #35

  • Removes permissions section as it's not relevant to general usage
  • Updates out of date sections and adds links to relevant modules
  • Adds emojis

@achingbrain achingbrain requested a review from a team as a code owner April 10, 2023 09:08
Refs #35

Adds answers to questions asked in that issue.
@achingbrain achingbrain changed the title docs: update manifesto docs: add manifesto Apr 10, 2023
@achingbrain achingbrain changed the title docs: add manifesto docs: add FAQ Apr 10, 2023
@achingbrain achingbrain requested a review from BigLep April 10, 2023 09:13
Copy link
Contributor

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

this a good start. I think there are other important questions though that we should answer like:

  1. why consider using Helia over js-ipfs
  2. why use Helia over the kubo-rpc-client
  3. what mechanisms does Helia have for content and peer routing?
  4. what data transports does Helia have

Basically I think we should extract out portions of https://blog.ipfs.tech/state-of-ipfs-in-js/ . Understood if that needs to happen in a followup.

FAQ.md Outdated Show resolved Hide resolved
FAQ.md Outdated Show resolved Hide resolved
FAQ.md Outdated Show resolved Hide resolved
FAQ.md Outdated Show resolved Hide resolved
FAQ.md Outdated Show resolved Hide resolved
@@ -29,7 +29,7 @@

A lean, modular, and modern implementation of IPFS for the prolific JS and browser environments.

See the [Manifesto](./MANIFESTO.md) and the [State of IPFS in JS blog post from October 2022](https://blog.ipfs.tech/state-of-ipfs-in-js/) for more info.
See the [Manifesto](./MANIFESTO.md), the [FAQ](./FAQ.md), and the [State of IPFS in JS blog post from October 2022](https://blog.ipfs.tech/state-of-ipfs-in-js/) for more info.
Copy link
Contributor

Choose a reason for hiding this comment

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

https://blog.ipfs.tech/state-of-ipfs-in-js/ was a snapshot in time. I think we should extract ou the parts that are relevant that are still true. We can point back to it as a historical pointer, but I think that should be a "Related / Historial Items" section likely in the manifesto doc. I think we want this repo to represent the latest state of affairs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, maybe we can remove or update that in a different PR?

Co-authored-by: Steve Loeppky <[email protected]>
@achingbrain achingbrain merged commit 3446638 into main Apr 12, 2023
@achingbrain achingbrain deleted the docs/add-faq branch April 12, 2023 15:22
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.

2 participants