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

Make certain usage patterns more prominent in the README #3557

Merged
merged 4 commits into from
Jul 18, 2022

Commits on Jun 27, 2022

  1. Make certain usage patterns more prominent in the README

    We use this library extensively where I work. After pairing with many
    teammates, I've learned that one common stumbling point when using this
    library is how to first get a JSON value in the first place (because
    once they have a variable of type `json` in hand, the API is intuitive
    and mostly does what you expect).
    
    With that in mind, I've added two subsections to the top of the Examples
    section: how to read JSON from a file, and how to hardcode a JSON
    literal.
    
    I understand that these are already documented elsewhere in the Examples
    section, and so these new subsections are technically redundant. But to
    defend this choice:
    
    - Redundancy in docs is actually good, because not everyone consumes
      docs in the same way or in the same order.
    
    - Having these things called out explicitly in isolation encourages
      people to get something working faster. In later sections, these
      examples are presented alongside many other options. Having to choose
      between alternatives gets in the way of quickly prototyping something.
    
    If you have further suggestions for how to improve or modify these docs
    I'm open to them. The changes included here would really make a huge
    improvement in the productivity of newer members of my team using this
    library.
    jez committed Jun 27, 2022
    Configuration menu
    Copy the full SHA
    b70f62e View commit details
    Browse the repository at this point in the history

Commits on Jul 6, 2022

  1. Remove old TOC entry

    jez committed Jul 6, 2022
    Configuration menu
    Copy the full SHA
    1c56a47 View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2022

  1. Put the section back

    jez committed Jul 17, 2022
    Configuration menu
    Copy the full SHA
    1807752 View commit details
    Browse the repository at this point in the history
  2. Another tweak

    jez committed Jul 17, 2022
    Configuration menu
    Copy the full SHA
    fbc9289 View commit details
    Browse the repository at this point in the history