Schema in docs #195
Merged
Schema in docs #195
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
|
See the preview here: https://github.com/open5e/open5e-api/blob/schema-in-docs/docs/schema.md |
Merged
|
Awesome, love to see documentation gains. I'd love it if we could set up automatic regeneration in the future. |
Gredelston
approved these changes
Apr 8, 2023
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 adds a schema diagram using mermaid being generated and put into /docs/schema.md. Mermaid diagrams are fully supported by github-flavored markdown, and there's a pretty cool explorable diagram of everything in the database there. I also added a document that more or less says how I created the original diagram in a fairly repeatable format.