Skip to content
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
wants to merge 102 commits into from

Conversation

braaar
Copy link
Member

@braaar braaar commented Oct 6, 2022

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

  • the pull request title describes what this PR does (not a vague title like Update index.md)
  • the pull request targets the default branch of the repository (develop)
  • the code follows the established code style of the repository
    • npm run prettier:check passes
    • npm run lint:check passes
  • tests are added for the changes I made (if any source code was modified)
  • documentation added or updated
  • I have run the project locally and verified that there are no errors

Fixes

fixes #595, fixes #1155

dependabot bot added 30 commits November 22, 2021 09:06
dependabot bot and others added 24 commits March 3, 2022 09:07
@NoNameProvided
Copy link
Member

Landed in 7cd7546. Thanks!

(I have to cherry-pick due to merge conflict.)

@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

fix: schema-based validation not working Schema example in README.md not work
2 participants