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

Improve documentation #54

Open
thill-odi opened this issue Aug 4, 2020 · 0 comments
Open

Improve documentation #54

thill-odi opened this issue Aug 4, 2020 · 0 comments
Assignees

Comments

@thill-odi
Copy link
Contributor

The existing documentation is good as far as it goes, but leaves out a lot of context. To illustrate more fully how the library is to be used, we need to make clear that the library is essentially used to create a (very simple) API.

This means we need to lay out a straightforward sequence for developers walking them through from receiving the request to returning the response. We thus need steps, with examples, illustrating:

  1. Receiving a request
  2. Parsing the request for parameters
  3. Querying the database
  4. Using the query results to create data items
  5. Sequencing these data items
  6. Wrapping up these data items as an RPDE feed
  7. Serialising the RPDE feed to JSON
  8. Returning this JSON as a response
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