Skip to content

Conversation

@salmad3
Copy link
Contributor

@salmad3 salmad3 commented Jan 5, 2023

Context

Latest preview

Please view the latest Fleek preview here.

@salmad3 salmad3 marked this pull request as draft January 5, 2023 10:22
@salmad3 salmad3 added the ready for review PR is ready for review label Jan 6, 2023
@salmad3 salmad3 marked this pull request as ready for review January 6, 2023 11:12
@salmad3 salmad3 requested review from MarcoPolo and removed request for raulk January 20, 2023 16:28
@salmad3 salmad3 added the P1 High label Jan 26, 2023
@MarcoPolo MarcoPolo removed the request for review from marten-seemann January 26, 2023 21:23
@salmad3 salmad3 added change request PR requires changes. and removed ready for review PR is ready for review labels Jan 26, 2023
@salmad3
Copy link
Contributor Author

salmad3 commented Jan 27, 2023

thanks for the review, @MarcoPolo!

I don't see the value in the docs if we abstract the material to the point where we are generally only mentioning something along the lines of "this is a protocol, this is the protocol in libp2p, and this is the protocol ID" and not have context on how something works. However, I still agree that we should continue to abstract material that is primarily relevant to libp2p users.

What about an approach where we present more context on a subject matter in an optional dropdown menu. For example:

image

@MarcoPolo
Copy link
Contributor

I don't see the value in the docs if we abstract the material to the point where we are generally only mentioning something along the lines of "this is a protocol, this is the protocol in libp2p, and this is the protocol ID". However, I also agree that we should continue to abstract material that is primarily relevant to libp2p users.

The most important things are:

  1. What is this thing at a high level, and where can I learn more about this thing?
  2. How does libp2p use this at a high level, and where can I learn more?
  3. How does this help me.

For Noise this would be:

  1. An encryption scheme that has been heavily reviewed and is used by Signal. learn more at https://noiseprotocol.org.
  2. libp2p uses this as a way to encrypt data between nodes and provide forward secrecy. See more at the
  3. This helps you send data end to end encrypted by default.

A user reading this doc should be able to understand how they would make use of this protocol. When I buy a hammer I only need to know which part I whack, not the process of making the hammer.


The problem with putting too much stuff in here is that then we need to review everything much more carefully. This turns the documentation into a spec rewrite. And makes it really brittle to any future changes. The higher level stuff targetting users is more likely to be true no matter what small changes we make. e.g. Noise will never not be used to encrypt your data end to end.

@salmad3
Copy link
Contributor Author

salmad3 commented Jan 27, 2023

I hear you @MarcoPolo, thanks. I incorporated the suggestions.

@salmad3 salmad3 added ready for review PR is ready for review and removed change request PR requires changes. labels Jan 27, 2023
@salmad3 salmad3 requested a review from MarcoPolo January 27, 2023 00:43
Copy link
Contributor

@MarcoPolo MarcoPolo left a comment

Choose a reason for hiding this comment

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

Thank you :)

@salmad3 salmad3 removed the ready for review PR is ready for review label Jan 27, 2023
@salmad3 salmad3 merged commit efdf0db into master Jan 27, 2023
@salmad3 salmad3 removed the P1 High label Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Populate secure communication section: Noise & TLS

3 participants