Skip to content

docs(readme): align the readme with the code - #54

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

danielebarbaro merged 1 commit into
mainfrom
docs/readme-accuracy

Conversation

@danielebarbaro

Copy link
Copy Markdown
Contributor

I checked the README line by line against the commands, the traits and the stubs. Docs only, no code changes.

Wrong, now fixed

  • The link to "Model directory" was broken: the heading emoji left an invisible character in the anchor GitHub generates.
  • The first "Configuration" section told users to publish the stubs. getStub() only reads the stubs of the package, so published ones have no effect. The section is removed, the config tag is still documented further down.
  • clean-arch:make-domain User was the running example. On a Laravel app the User model, its factory and the users migration already exist. The example is now Product, with a pointer to --user-in-domain.
  • "Model directory" listed make-controller and make-service among the commands that read it. Their stubs never import the model.
  • --user-in-domain: bootstrap/ was missing from the rewritten folders, the rule for removing app/Models and app/Http was imprecise, and the third refusal case (no User to move) was missing.
  • "The package does not edit your autoloader" was not true: clean-arch:install restores the App\ entry when it is missing.
  • clean-arch:generate-package has a --path= option that was not listed.
  • The paragraph on inheritance chains referred to a "previous hand written analyser" and assumed a rule that is off by default.
  • "AI guidelines (Laravel Boost)" was a subsection of "Moving User into the Domain in an existing app".

Added

  • "Generating single classes": one table with the file each make-* command writes, plus the naming rules the README never stated (suffixes are not doubled, make-listener writes *EventListener.php, make-controller defaults to API).
  • The files make-domain writes outside app/.

Anchors

Two anchors changed (configuration-1 and the generated structure heading). Hidden anchors keep the old ones working, checked against GitHub's markdown renderer.

CHANGELOG not touched.

@danielebarbaro
danielebarbaro merged commit ee9c873 into main Nov 19, 2026
8 checks passed
@danielebarbaro
danielebarbaro deleted the docs/readme-accuracy branch November 19, 2026 11:45
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