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

Refactor for accessible reading #15

Open
mixmix opened this issue Feb 22, 2020 · 0 comments
Open

Refactor for accessible reading #15

mixmix opened this issue Feb 22, 2020 · 0 comments

Comments

@mixmix
Copy link
Member

mixmix commented Feb 22, 2020

I introduced @staltz to this repo the other day, and in giving him a verbal tour, I was aware that the order the details are laid on in here is really crappy for a first time person.

I think a refactor should be something like:

  1. the context in which this can be used, and what it's designed for
  2. how to unbox (high level), which shows how the sections/ anatomy is traversed
  3. second pass with more detail
    • how the keys are derived for each section
    • a closer look at exactly how each section is composed in bytes, extra options, etc
  4. links out to detailed specs + design considerations for each part
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

1 participant