chore: clean up unused wiki docs, add rate limiter example to README - #315
Open
slowbackspace wants to merge 2 commits into
Open
chore: clean up unused wiki docs, add rate limiter example to README#315slowbackspace wants to merge 2 commits into
slowbackspace wants to merge 2 commits into
Conversation
The GitHub wiki is no longer maintained and has been disabled on the repository. Remove the typedoc docs script and dependencies, and point README links to the source instead of the wiki.
slowbackspace
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Wiki cleanup
The GitHub wiki is no longer maintained and has been disabled on the repository (the stale
github-pagesdeployments from 2023 were also removed).docstypedoc script and thetypedoc,typedoc-github-wiki-theme, andtypedoc-plugin-markdowndevDependencies (eslint-plugin-tsdocstays — the lint config uses it)src/utils/helpers.ts, and remove the "regenerate wiki docs" step from the development guideRate limiter docs (closes #256)
rateLimiterproperty (the underlying Bottleneck instance), with an example of inspecting the current queue viacounts()/queued(), checking remaining capacity viacurrentReservoir(), and subscribing to thedepletedeventCloses #256
🤖 Generated with Claude Code