Skip to content

docs(readme): move the long guides to docs - #56

Merged
danielebarbaro merged 1 commit into
mainfrom
docs/split-readme
Nov 19, 2026
Merged

danielebarbaro merged 1 commit into
mainfrom
docs/split-readme

Conversation

@danielebarbaro

Copy link
Copy Markdown
Contributor

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 and no_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:

  • Every section heading that existed before, so links to them and the two command messages that say "read ... in the README" still land in the right place. Each one keeps a short summary and a link to its guide.
  • A new "Documentation" section after the installation, listing the three guides.
  • A table of every config key with its default, in place of the detailed sections.
  • The paragraph on how generators treat existing files, moved from "Configuration" to "Available commands".

Links to the moved subsections (#-validation-rules, #-model-directory, #️-the-autoload-guard and the like) no longer resolve in the README.

Docs only, no code changes. CHANGELOG not touched.

@danielebarbaro
danielebarbaro merged commit 9c94158 into main Nov 19, 2026
8 checks passed
@danielebarbaro
danielebarbaro deleted the docs/split-readme branch November 19, 2026 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant