internetarchive / internetarchive/openlibrary
Documentation Page needed for Bulk Search
- Dominant language
- Python
- Stars
- 6.7k
- Forks
- 2k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 138
Description
### Proposal
Currently, there is no easily accessible documentation from the Bulk Search page detailing how to properly use it. It would probably be best if it was linked to a 'help' page of some kind, to help users that might otherwise struggle with it.
### Justification
This problem addresses a lack of well-explained instructions and guidance for Bulk Search. It will primarily impact audiences that are unfamiliar with API keys, and it will explain the reason behind the 'beta' tag that will soon be placed on that extraction option.
The predicted impact will likely be minor, but useful. Success will be a new page created that has detailed descriptions for any users that are struggling to make proper use of the UI, likely with some visual examples to go with a text-based explanation.
### Breakdown
#### Requirements Checklist
* [ ]
#### Related files
*
#### Stakeholders
*
#### Instructions for Contributors
Please [run these commands](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#working-on-your-branch) to ensure your repository is up to date **before** [creating a new branch](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#making-changes-and-creating-a-pull-request) to work on this issue and **each time after** pushing code to Github, because the pre-commit bot may add commits to your PRs upstream.
Contributor guide
Assessment
This issue has not been assessed yet.