Repository navigation
docs(readme): move the long guides to docs - #56
Merged
Merged
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.
The README was 649 lines, and almost half of it only matters when migrating an existing app or tuning the rules. It is now 422 lines, with three guides under
docs/:docs/migrating-an-existing-app.md:--user-in-domain,--migrate-app, and the table of what breaks on an app already in production.docs/architecture-validation.md: phparkitect, the autoload guard, the baseline, the validation rules andno_classes_outside_layers.docs/configuration.md: directories, custom messages, base classes, model directory, job prefix, web controller path.The text of the moved sections is unchanged, apart from the links between them. Headings in the guides have no emoji, so their anchors are plain.
What stays in the README:
Links to the moved subsections (
#-validation-rules,#-model-directory,#️-the-autoload-guardand the like) no longer resolve in the README.Docs only, no code changes. CHANGELOG not touched.