Add a file to keep track of deprecated features #1371
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
victorlin
force-pushed
the
victorlin/deprecated-file
branch
from
5d4d4c4
to
44314cd
Compare
jameshadfield
approved these changes
Dec 20, 2023
|
I just realized we have the Breaking Changes docs page, which overlaps with DEPRECATED.md. I'll merge the two together. |
Descriptive text inspired by an analogous file used in the Commander.js repo.¹ ¹ <https://github.com/tj/commander.js/blob/f1ae2db8e2da01d6efcbfd59cbf82202f864b0c1/docs/deprecated.md>
I created DEPRECATED without knowing that there was already a similar page in the docs. That page was not very visible to developers, with no mention in the dev docs. Instead of continuing with the breaking changes file, move relevant contents into DEPRECATED and automatically render DEPRECATED in the docs.
victorlin
force-pushed
the
victorlin/deprecated-file
branch
from
e6c2fe4
to
8862cfe
Compare
victorlin
commented
Dec 20, 2023
jameshadfield
approved these changes
Dec 20, 2023
This documents the process of adding to the new DEPRECATED.md file.
victorlin
commented
Dec 20, 2023
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.
Description of proposed changes
Descriptive text inspired by an analogous file used in the Commander.js repo.¹
¹ https://github.com/tj/commander.js/blob/f1ae2db8e2da01d6efcbfd59cbf82202f864b0c1/docs/deprecated.md
Related issue(s)
export v1#1266Checklist