This repository has been archived by the owner on Jan 29, 2020. It is now read-only.
Provide versioned documentation #127
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
Imports all v2 documentation as of last stable release. Updates it to remove references to v1-specific functionality.
- Removes references to obsolete/removed functionality. - Updates examples to PSR-15.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In working on #122 and #124, I've come to the conclusion that we need versioned documentation for this component. Doing so allows us to refer users to the documentation specific to their major version, but also allows us to simplify examples: v1 code samples show only code compatible with v1, etc.
This patch provides a possible approach, by creating two trees,
v1andv2, each with their version-specific documentation. Documentation for the current/upcoming version is in the root tree.