Skip to content

Commit 59c132c

Browse files
committed
Mention development validator and documentation site
1 parent 1b30229 commit 59c132c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/blog/posts/bids-validator-2.0.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,31 @@ We hope that a consistent validator will help inform future changes to BIDS,
114114
so that the specification can get closer to the needs and preferences
115115
of the community.
116116

117+
### Development validator
118+
119+
The BIDS Validator tracks the latest release of the BIDS specification (currently [v1.10.0]).
120+
As the next release of BIDS is developed, changes to the schema or the validator may be
121+
tested at <https://bids-standard.github.io/bids-validator/dev/>.
122+
123+
Note that any changes in this validator may be reverted prior to the next release of BIDS.
124+
Command-line use of the development validator is not currently supported.
125+
126+
### Updated documentation
127+
128+
The original BIDS validator had limited documentation,
129+
primarily a README that was replicated on GitHub and [NPM][npm:validator].
130+
For the 2.0 release of the validator, we've added documentation at
131+
<https://bids-validator.readthedocs.io/en/latest/>.
132+
133+
In addition to user guides for the [web][web-validator] and [command-line] interfaces
134+
to the validator, we aim to include more detail on the operation of the validator,
135+
starting with the [validation model][].
136+
Our goal is to demystify the validator and the BIDS Schema and empower researchers and
137+
developers to adapt and reuse the tools we've built.
138+
139+
This site is under active development, and will be updated frequently in the
140+
coming weeks. Please help us improve it by opening issues (or PRs)!
141+
117142
## Questions
118143

119144
### Q1. My dataset was valid with the old validator but it is not anymore. Why? Which one should I trust?
@@ -408,3 +433,13 @@ inside the [bids-standard/bids-specification] repository.
408433
[bids derivatives]: https://bids-specification.readthedocs.io/en/stable/derivatives/introduction.html
409434

410435
[BIDS-MRS]: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/magnetic-resonance-spectroscopy.html
436+
437+
[npm:validator]: https://www.npmjs.com/package/bids-validator
438+
439+
[web-validator]: https://bids-validator.readthedocs.io/en/latest/user_guide/web.html
440+
441+
[command-line]: https://bids-validator.readthedocs.io/en/latest/user_guide/command-line.html
442+
443+
[validation model]: https://bids-validator.readthedocs.io/en/latest/validation-model/index.html
444+
445+
[v1.10.0]: https://bids-specification.readthedocs.io/en/v1.10.0/

0 commit comments

Comments
 (0)