Fix formatting #2
Open
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
This splits the documentation of the Siren format into its individual elements. The old style on one page was hard to take as reference when working with the format. The parts are linked to each other where needed
|
We could also scrap Markdown and switch to HTML. This way, we could provide an outline at the side to increase readability even more. |
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 PR aims to increase the readability of the Siren documentation by splitting it into multiple pages. The description of the root Entity still resides in README.md, but the other parts are now contained in their own files.
This solves the problem of the hard-to-grasp hierarchy of the one-page README that was apparent in the documentation before these changes. All parts are interlinked so reviewing the docs when working with the format should now be easier.