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

Create index page based on the schema #900

Closed
tsalo opened this issue Oct 14, 2021 · 5 comments · Fixed by #923
Closed

Create index page based on the schema #900

tsalo opened this issue Oct 14, 2021 · 5 comments · Fixed by #923
Labels
enhancement New feature or request schema Issues related to the YAML schema representation of the specification. Patch version release.

Comments

@tsalo
Copy link
Member

tsalo commented Oct 14, 2021

I think it might be useful to create an index page based on the schema. Basically, the page would include all of the object definitions in the schema, broken down by object type (e.g., datatype, metadata field, suffix), and hopefully linking to any uses of that object in the specification.

@tsalo tsalo added enhancement New feature or request schema Issues related to the YAML schema representation of the specification. Patch version release. labels Oct 14, 2021
@Remi-Gau
Copy link
Collaborator

an index page in the specification itself or like in the README in the schema folder?

either way I really like the idea

@tsalo
Copy link
Member Author

tsalo commented Oct 14, 2021

I'm thinking in the specification itself, but it wouldn't have to be in the sidebar or anything. It could be buried until we find a real use for it (e.g., as an API maybe?).

@Remi-Gau
Copy link
Collaborator

actually did you mean more like a glossary than an index ?
(like a more official version than the starter kit version: https://github.com/bids-standard/bids-starter-kit/wiki/Glossary

@tsalo
Copy link
Member Author

tsalo commented Oct 15, 2021

A glossary would be a great start, although optimally we'd also be able to generate links back to the specification text where the terms are used.

@sappelhoff
Copy link
Member

A glossary would be a great start, although optimally we'd also be able to generate links back to the specification text where the terms are used.

great idea, +1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants