-
Notifications
You must be signed in to change notification settings - Fork 806
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: remove schema based validation from readme #1755
Closed
Closed
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
NoNameProvided
force-pushed
the
develop
branch
from
November 13, 2022 11:46
2ef8ff0
to
0da8f89
Compare
Landed in 7cd7546. Thanks! (I have to cherry-pick due to merge conflict.) |
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
According to the roadmap #178 and several comments by @NoNameProvided, schema based validation is on its way out. Additionally, it is currently broken. Due to the limited maintainer resources on this project, it is probably unwise to spend effort on trying to fix this feature before removing it again in the next major version.
Therefore I have made this PR removing the schema based validation instructions from the readme in order to avoid further confusion.
We could remove the actual code for this feature, since it doesn't work. But I suppose that is technically a breaking change, so I'm not sure what's the best way to go about that
Checklist
Update index.md
)develop
)npm run prettier:check
passesnpm run lint:check
passesFixes
fixes #595, fixes #1155