chore: move changelog to docs folder/mintlify #420
Merged
Conversation
This file contains 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
Also removed it and some other files from what gets published to npm. I think it's pretty rare for users to look in node_modules for documentation, and npm automatically includes the bits it needs (like package.json). It won't make a huge difference in file size, but multiplied by millions of downloads per week, it starts to add up to something significant.
gamemaker1
changed the title
Martii
added a commit
to Martii/express-rate-limit
that referenced
this pull request
Nov 20, 2023
* Affects https://github.com/express-rate-limit/express-rate-limit/releases pages * Assume directing devs/users to offsite area instead of [current dev location](https://github.com/express-rate-limit/express-rate-limit/blob/main/docs/reference/changelog.mdx) Post express-rate-limit#420
nfriedly
pushed a commit
that referenced
this pull request
Nov 20, 2023
* Affects https://github.com/express-rate-limit/express-rate-limit/releases pages * Assume directing devs/users to offsite area instead of [current dev location](https://github.com/express-rate-limit/express-rate-limit/blob/main/docs/reference/changelog.mdx) Post #420
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also removed the changelog and some other files from what gets published to npm. I think it's pretty rare for users to look in
node_modulesfor documentation (especially for something like this that's designed for online use), and npm automatically includes the bits it needs (like the readme & package.json), so we don't need to specify those.It won't make a huge difference in file size, but multiplied by millions of downloads per week, it starts to add up to something significant.
(I originally noticed that we had a broken link to docs/changelog.md so I fixed that and some other broken links and pushed the fix to
mainright away, but then I thought it probably would make sense to move the changelog over to the docs.)