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

Better emphasize benefits of Narwhal/Tusk in docs.sui.io Learn section #3107

Closed
Clay-Mysten opened this issue Jul 8, 2022 · 1 comment · Fixed by #3765
Closed

Better emphasize benefits of Narwhal/Tusk in docs.sui.io Learn section #3107

Clay-Mysten opened this issue Jul 8, 2022 · 1 comment · Fixed by #3765
Assignees
Labels
Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering Type: Documentation Improvements or additions to documentation
Milestone

Comments

@Clay-Mysten
Copy link
Contributor

What are the existing URLs containing the issue, if any?
https://docs.sui.io/learn/about-sui
https://docs.sui.io/learn/sui-compared
https://docs.sui.io/learn/how-sui-works

How would you describe the issue? (What needs changing?)
We introduced Narwhal months ago but truly make little reference to its benefits given the docs above precede the consensus protocol's launch. See feedback indicating as much in:
https://discord.com/channels/916379725201563759/955861929346355290

We should fix that. Thanks to @sblackshear for reporting it. See other related fixes to terminology in:
#2672

Where should this information land if new? (Learn, Build, Explore, Contribute.)
See the URLs above. Here is the target for linking:
https://github.com/MystenLabs/narwhal

What changes are needed to support this new feature or product? (A simple overview, detailed procedures?)
N/T need more links in.

Who is the audience for that information? (App developers, investors, creators, validators, someone else?)
System implementers

What precisely must they do with it? (Configure a new service? Process some output?)
Use the consensus protocol for more complex (shared) transactions.

@Clay-Mysten Clay-Mysten added the Type: Documentation Improvements or additions to documentation label Jul 8, 2022
@Clay-Mysten Clay-Mysten added this to the [D] Wave 3 milestone Jul 8, 2022
@Clay-Mysten Clay-Mysten added the Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering label Jul 8, 2022
@Clay-Mysten Clay-Mysten linked a pull request Aug 4, 2022 that will close this issue
@Clay-Mysten
Copy link
Contributor Author

Progress in:
#3765

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants