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

[TASK] Protocol | Provide simplified diagrams to improve readers understanding #78

Open
2 tasks
Tracked by #70
dutterbutter opened this issue Mar 9, 2023 · 1 comment
Open
2 tasks
Tracked by #70

Comments

@dutterbutter
Copy link
Contributor

dutterbutter commented Mar 9, 2023

Overview

We should review and update the verbosity of our explanation how each protocol works with a series of diagrams. The reader should be able to read / review documentation of each protocol and leave with an understanding how the protocol works. This requires more verbosity in our explanations and visual examples (e.g. diagrams). For inspiration can review the following link.

Task Checklist

  • Review each protocol and improve the explanation and breakdown
  • Add diagrams that aid in the understanding of each protocol
@dutterbutter dutterbutter changed the title [TASK] Provide simplified diagrams to improve readers understanding [TASK] Protocol | Provide simplified diagrams to improve readers understanding Mar 9, 2023
@dutterbutter dutterbutter moved this to Planning 🗺️ in Webb Universe Mar 10, 2023
@akileshtangella akileshtangella moved this from Planning 🗺️ to Building 🏗️ in Webb Universe Mar 11, 2023
@akileshtangella akileshtangella moved this from Building 🏗️ to Planning 🗺️ in Webb Universe Mar 13, 2023
@akileshtangella akileshtangella moved this from Planning 🗺️ to Building 🏗️ in Webb Universe Mar 13, 2023
@akileshtangella akileshtangella moved this from Building 🏗️ to Planning 🗺️ in Webb Universe Mar 14, 2023
@akileshtangella akileshtangella moved this from Planning 🗺️ to Building 🏗️ in Webb Universe Mar 15, 2023
@akileshtangella akileshtangella moved this from Building 🏗️ to Planning 🗺️ in Webb Universe Mar 15, 2023
@akileshtangella
Copy link
Contributor

There are good diagrams for the anchor system: https://docs.webb.tools/docs/anchor-system/overview/

Please let me know which protocols you think diagrams are missing for and I will make them. Thanks!

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

No branches or pull requests

2 participants