feat: render separate markdown files for each schema def #24
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #24 +/- ##
==========================================
- Coverage 87.80% 86.36% -1.44%
==========================================
Files 9 9
Lines 705 741 +36
==========================================
+ Hits 619 640 +21
- Misses 64 77 +13
- Partials 22 24 +2 ☔ View full report in Codecov by Sentry. |
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.
This MR updates the
gencommand to create a separate markdown file for each schema defined in an input file. Previously we were creating a single file per-input file, with all the schemas from that file aggregated together.This change was motivated by the limitations of our previous layout. We were trying to display everything in the "Properties" table, and it's difficult to put complex markup in a markdown table due to how whitespace affects layout. Now that we're only rendering a single schema per-file, we have moved the full description, enum options, and examples to linked sections below the properties table: