New documentation structure #947
Closed
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
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 provides a reworked documentation structure as a fix of #884, with the help of @dunglas.
The
coresection is now organized as many sublevels in order to tidy up the documentation and avoid newcomers and experts to be lost in the growing docs.Some sections has been moved to dedicated
.mdfiles, some concepts have been re-explained and all internal links have been checked.This will make the diff kinda hard to read, the best is to refer to api-platform/website#184 and #185 to read this version of the documentation in a localhost. Those tickets are required to be merged before using this PR, otherwise the actual API-Platform website won't be able to render the docs properly.