Autogenerate scenario schema doc #1441
Merged
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
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
4 times, most recently
from
228b5b1
to
3180bb0
Compare
xsebek
reviewed
Aug 23, 2023
src/Swarm/Doc/Scenario.hs
Outdated
| makePandocTable (fn, schm) = | ||
| setTitle (text "JSON Schema for Scenarios") $ | ||
| doc $ | ||
| header 3 (text $ T.toTitle $ T.pack fn) <> para (text $ description schm) <> myTable |
There was a problem hiding this comment.
There is a section in Get.hs for generating tables manually:
-- ----------------------------------------------------------------------------
-- GENERATE TABLES: COMMANDS, ENTITIES AND CAPABILITIES TO MARKDOWN TABLE
-- ----------------------------------------------------------------------------
We could reuse that here or make Gen.hs use Pandoc as well if Doc is split out.
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
from
3180bb0
to
19199f3
Compare
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
10 times, most recently
from
e553a0c
to
5f27081
Compare
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
from
5f27081
to
ba81aa3
Compare
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
4 times, most recently
from
ca2ef0d
to
e022916
Compare
kostmo
force-pushed
the
feature/scenario-schema-docs
branch
from
e022916
to
c314cc5
Compare
byorgey
approved these changes
Oct 9, 2023
Merged
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.
Closes #1436.
The schema
.jsonfiles are now the authoritative source of truth for documentation.Wrote a very simple parser for JsonSchema to extract the documentation from JSON.
Split the README.md into static and auto-generated parts.
Added a custom
"footers"key to schema files to support inclusion of other markdown files for each object description.Schema doc regeneration