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.

Sign up for GitHub

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

Jump to bottom

Updates to Getting Started #141

Open
staplegun opened this issue Mar 3, 2019 · 2 comments
Open

Updates to Getting Started #141

staplegun opened this issue Mar 3, 2019 · 2 comments
Assignees
@staplegun
Labels
documentation Interface: Guides, documentation, etc.

Comments

@staplegun
Copy link
Contributor

staplegun commented Mar 3, 2019 •
edited
Loading

Areas to review

  • Add 'On this page' content links at the top
  • Contact details - email, GH issues
  • Check all examples are up to date
  • Using an API key - tidy up text
  • Endpoints - move note to start?
  • Searching - update example - now has record count, etc
  • Fields - integrate with new field list page in Add field list documentation page #140
  • Searchable field - would be nice to include full example, e.g. label and date
  • Reverse Searchable field - update list
  • Sorting - expand with eg, For example a query on bark returns 2000 results, but if you sort on date you will only see the 400 that have a date [not real numbers]
  • Beta - update record count, which fields, label "Version 1 release"?

Nice to have - quick overview of using JSON-LD

  • requesting
  • multiple context files - primarily LA/CRM, our local terms aren't resolvable?
  • how search results contain record count
  • conversion tools
@staplegun staplegun added the documentation Interface: Guides, documentation, etc. label Mar 3, 2019
@staplegun staplegun self-assigned this Mar 3, 2019
@staplegun
Copy link
Contributor Author

Removed the list of searchable fields and replaced it with a link to the 'Searching the API' page (which contains the lists).

@staplegun
Copy link
Contributor Author

Finished updates to Getting Started page:

  • Added table of contents
  • Added contact details
  • Tidied text for API Keys and endpoints
  • Sample records updated

Only remaining is field list - to be completed in #140

@nmamanager nmamanager moved this to NMA to review / do in Documentation Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@staplegun staplegun

Labels
documentation Interface: Guides, documentation, etc.
Projects
Documentation
Status: NMA to review / do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@staplegun