Skip to content
This repository has been archived by the owner on Jan 22, 2025. It is now read-only.

Bugs in turbine docs #29766

Closed
aeyakovenko opened this issue Jan 18, 2023 · 1 comment
Closed

Bugs in turbine docs #29766

aeyakovenko opened this issue Jan 18, 2023 · 1 comment

Comments

@aeyakovenko
Copy link
Member

aeyakovenko commented Jan 18, 2023

Problem

Turbine docs have typos and bugs. Reported by researches looking at the code and documentation.

Screen Shot 2023-01-18 at 1 45 41 PM

Proposed Solution

fix them

tag @behzadnouri @jbiseda

@bw-solana
Copy link
Contributor

Here are the items I've spotted that need to be cleaned up (in order of appearance from top to bottom):

  1. Note that we possibly share shreds with neighbors. We will stop doing this once Redundant Turbine Path feature is enabled.
  2. Layer 0 is actually a special case Root node. Layer 1 = neighborhood 0
  3. Neighborhood assignment seed is derived from shred index + type
  4. Include root in diagrams/explanations in Layer & Neighborhood structure sections
  5. Mention or link to Redundant Turbine Path feature and how this impacts flows.
  6. Typo: trails --> trials*
  7. Shred group failure rate is actually computing the success rate. Add a 1 - to invert this
  8. Trials number is wrong for 16:16 FEC example 64 --> 32*
  9. Neighborhoods section should likely be moved under Layer and Neighborhood Structure section

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants