Doc updates

[SueSmith]

First go at completing/ updating the client docs. Few questions/ notes etc:

• Models: I've focused mainly on documenting the client object methods and haven't done a huge amount with the models stuff - what I have done on that page was mostly guesswork.. Should I add some examples and flesh the models info out more or would this be better suited to wiki type guides outside the /docs..?
• Claim codes: Are we still using these? I've documented them in the same way as the rest.. However:
  • claimClaimCode didn't work for me - the claimed field seems to update in the db but my app hangs and submitted emails don't get added to the email field. (I've commented out references to the method for the moment. Also didn't include method claim in models for the same reason.)
  • updateClaimCode gave me [MethodNotAllowedError: PUT is not allowed] - commented out.
  • generateRandomClaimCode gave me [NotAuthorizedError: Missing JWT claim: body] - commented out.
  • getClaimCodes without badge gives [ResourceNotFoundError: /systems/badgekit/codes does not exist] - should it be [ContextError: Context not of required type: Badge] ?
• On updateBadgeInstance I get [MethodNotAllowedError: PUT is not allowed] - commented out for now.
• On deleteReview the client seems to return null rather than the deleted review.. - haven't included the response in the docs for now.
• I've removed the evidence methods since I think these were removed from the API..

Give me a shout if anything isn't clear.. Feedback appreciated! 🙉

[cmcavoy]

Hey @SueSmith looks good to me...re: models, I think what you did so far is fine. Like you said, might make more sense as a tutorial down the line.

Claim codes

We're not using them for cities of learning, so they're back burnered. We'd like to use them long term, so please log the errors you found as issues against badgekit-api.

evidence

Just a heads up, I'm adding evidence into the badgekit-api this week.

[cmcavoy]

Also, I see why the tests are failing. I'll take care of that after we merge this.

[SueSmith]

Thanks @cmcavoy - will create those claim code issues and keep an eye out for evidence stuff.

[SueSmith]

Added the claim code issues - some on API, some on client (where relevant API endpoints seem ok).