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

More diagram detail #3

Open
mixmix opened this issue Feb 20, 2025 · 3 comments
Open

More diagram detail #3

mixmix opened this issue Feb 20, 2025 · 3 comments

Comments

@mixmix
Copy link

mixmix commented Feb 20, 2025

I loved reading this spec, and I also found some of the diagrams helped, but could have had some more detail. This issue is testing to see whether you're interested in contributions which improve the accessibility of some of the diagrams!

I did a little mockup of that might be possible with mermaid diagrams:

flowchart RL

subgraph level_2_a [ ]
    subgraph level_1_a [ ]
        subgraph A_label [3b0n..]
          A
        end

        subgraph B_label [00ab..]
          B
        end
    end

    subgraph level_1_b [ ]
        subgraph C_label [4hdn..]
          C
        end

        subgraph D_label [j39a...]
          D
        end

        subgraph E_label [000m...]
          E
        end
    end
end

subgraph F_label [3c28...]
  F
end

F --> E --> D --> C --> B --> A

%% #FFB200 - yellow
%% #EB5B00 - orange
%% #D91656 - pink
%% #640D5F - purple

classDef default fill:#EABDE6, stroke: none, color:#222;
classDef cluster fill:none, stroke:none, color:#222;

classDef level_one fill:#D69ADE;
classDef level_two fill:#AA60C8;

class level_1_a,level_1_b, level_one
class level_2_a, level_two
Loading

This doesn't have to be the direction diagrams go, but I was particularly interested in:

  • understanding how the strata boundaries landed more clearly
  • visualising the layering
  • making diagrams which show how different statum might compress different ranges and how we compare "support" for replication
@mixmix
Copy link
Author

mixmix commented Feb 20, 2025

More doodles: https://hackmd.io/QDFR3beQRQ64ntRVIkLIEQ?view

@alexjg
Copy link
Contributor

alexjg commented Feb 20, 2025

I'm very open to more diagrams like this, and yours look great. I'm also not committed to Mermaid, it was just the easiest way to get some simple diagrams in a hurry.

If you drop in a PR I will gladly review it. However, I will also note that we are about to open source the Keyhive repository next week and I'll move all of this code to that repository then, so if you do open a PR I'll probably hold off on merging it until we've moved the code and then suggest re-submitting it there so that you get credit for the work.

@mixmix
Copy link
Author

mixmix commented Feb 26, 2025

Thanks @alexjg ! Look forward to seeing the new home + taking code for a spin!
Can you ping me when there''s a clear new home sorted? I'm [email protected]

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

No branches or pull requests

2 participants