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 manifesto #84

Merged
merged 5 commits into from
Apr 13, 2023
Merged

docs: update manifesto #84

merged 5 commits into from
Apr 13, 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

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 BigLep April 7, 2023 16:37
@achingbrain achingbrain requested a review from a team as a code owner April 7, 2023 16:37
MANIFESTO.md Outdated Show resolved Hide resolved
MANIFESTO.md Outdated Show resolved Hide resolved
achingbrain and others added 2 commits April 11, 2023 15:00
Co-authored-by: Alex Potsides <alex@achingbrain.net>
MANIFESTO.md Outdated Show resolved Hide resolved
@BigLep
Copy link
Contributor

BigLep commented Apr 11, 2023

Hi Alex. I tried looking at this with fresh eyes and will someone not close to Helia get what Helia and why it exists.

It seems like another key design goal is to break open the "black box" of IPFS and have better visibility into what is happening by allowing a lot more events that can hook in to monitor and debug.

This probably doesn't belong here (maybe FAQ?) but I think we want to callout the things that arne't customizable. It sounds like the main area is data transfer currently, is that right? (We're assuming Bitswap and we don't expose configuration of bitswap - is that right?). (We have configurability over Content and Peer routing though as those are controlled by js-libp2p.

A laid visual could likely help here showing the relationship between the various components

  • helia
  • libp2p node
  • datastore
  • blockstore
  • bitswap
  • other helia modules
  • user application (consumer of helia)
    I don't exactly know how the picture should look but it seems a bit surprising not to have any architecture diagrams anywhere in the repo. It will also be useful for those who are more visual in their understanding.
    (Understood visual is more work. That can be a separate item. I expect it will be useful for IPFS Thing presentation. Let me know if it would be helpful to whiteboard together.)

@BigLep
Copy link
Contributor

BigLep commented Apr 11, 2023

Feel free to merge after you pick through the comments that make sense to apply now and backlog the others.

@achingbrain achingbrain merged commit 33461fe into main Apr 13, 2023
@achingbrain achingbrain deleted the docs/update-manifesto branch April 13, 2023 19:55
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