gleanwork / gleanwork/glean-developer-site
Improving clarity on rate limits.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8
- Forks
- 26
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 65
Description
docs/get-started/rate-limits.mdx
The rate limits are described as user-scoped, but some of the rate limits are for the indexing API, which does not have user-scoped tokens.
I was on a phone call with a customer today and one of their questions caught me off guard because they were using the push API and asking about user-scoped rate limits.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading docs/get-started/rate-limits.mdx and compare the descriptions for the indexing and push APIs. Clarify which limits are user-scoped and which apply to APIs without user-scoped tokens; the work is done when the documentation accurately distinguishes these cases.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100