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

Generic feedback #1

Open
gabesullice opened this issue Nov 28, 2018 · 2 comments
Open

Generic feedback #1

gabesullice opened this issue Nov 28, 2018 · 2 comments
Assignees

Comments

@gabesullice
Copy link

Hi @hibaymj!

I have some general feedback that I think would make this a lot easier to grok. Most of which I'm sure you're already aware of, so maybe this will just be a good todo list.

  • README.md in the project root
  • Table of Contents
  • Headings (h1, h2, h3...) to make it easier to pick out conceptual "chunks"
  • More newlines
  • Glossary of terms
  • More and smaller examples. It's fine to keep the long-form ones to "tie it all together" but there should be smaller ones for discrete pieces of this spec.
  • The "long-form" examples need more commentary
  • It's not clear why there are "prefer-based" and "profile-based" directories. Is that a decision yet to be made, or a choice for the implementor?

??? I'll add more as I can think of things.

@hibaymj
Copy link
Member

hibaymj commented Nov 28, 2018

I definitely plan to get this in a more standard format (IETF writer probably), but vim was all I had on hand overnight! Thanks for this feedback! I'll probably make a few separate issues for each of these items and tag you in them to discuss individually, but this is great! Thanks!

@hibaymj
Copy link
Member

hibaymj commented Nov 28, 2018

I updated the long form example in the prefer-based directory, as it was most relevant to the other conversations going on at the time.

Does this feedback still apply to the current state now, or was this from the profile-based directory?

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