docs: update output schema document #1024
Merged
Conversation
This file contains hidden or 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
completely rework the structure of the document reformat markdown tables simplify examples within code sample simplify ToC style changes make document style guide complaint disable markdownlint rule md001 for last section of the document
move file names from comments inside codebleck into codeblock through docusuarus feature
mtrunkat
reviewed
May 23, 2024
Member
mtrunkat
left a comment
mtrunkat
left a comment
There was a problem hiding this comment.
Just sending quickly some structure feedback:
- I really like that it now contains examples and screenshot what it actually does
- IMHO interlinking these would be benefitial
- these should be H3 and thanks to that they will appear in the TOC on the right
as in input schema
- It might be beneficial to separate it into 2 pages:
- Output schema (explanation with screenshots)
- Specification
as in input schema. The beneficial is that we can have then multiple specification versions and also that specs is not surrounded by extra content.
- I'd consider adding small snippets into "Dataset schema structure definitions" to make it easier to visualize it
Contributor
Author
Regarding this point, this was done on purpose, I thought that it muddles the TOC a bit, and this way the user can navigate the TOC to get to overall part of document that deals with dataset specification and from there, find the one that he needs to check |
removed gerund from heading changed ordered list to unordered list
gippy
approved these changes
May 29, 2024
Member
gippy
left a comment
gippy
left a comment
There was a problem hiding this comment.
Looks ok to me, much easier to read.
Contributor
Author
|
@davidjohnbarton this is now post reviews and will be merged today , tomorrow at the latest |
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.
completely rework the structure of the document
reformat markdown tables
simplify examples within code sample
simplify ToC
style changes
make document style guide complaint
disable markdownlint rule md001 for last section of the document