Fix incorrect setup instructions in README.md - #23
Merged
Conversation
The installation guide contained several errors that would break a fresh setup. The routing resource pointed at `@WebfactoryNewsletterRegistrationBundle/src/Controller.php`, but the bundle class lives in `src/`, so the bundle path already resolves to that directory and the reference expanded to a non-existent `src/src/Controller.php`; it now points at `@WebfactoryNewsletterRegistrationBundle/Controller.php`. The entity classes were referenced under `AppBundle\Entity\*` in the `resolve_target_entities` mapping, the service definitions and the "Adding fields" section, while the shipped templates declare them under `AppBundle\Newsletter\Entity\*`. All references now use the latter namespace consistently, and the template copy target and Doctrine mapping directory (`src/AppBundle/Newsletter/Entity/`) match it as well. Further corrections: `%kernel.root_dir%` (removed after Symfony 4) is replaced by `%kernel.project_dir%`; the `//` labels inside YAML blocks are turned into valid `#` comments; the `bundles.php` path is no longer prefixed with `src/`, which is a project-specific convention rather than a Symfony default; the `RecpientFactoryInterface` typo is corrected to `RecipientFactoryInterface`; and a couple of grammar and naming inconsistencies are cleaned up. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
janopae
changed the title
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
1 participant
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 installation guide contained several errors that would break a fresh
setup. The routing resource pointed at
@WebfactoryNewsletterRegistrationBundle/src/Controller.php, but thebundle class lives in
src/, so the bundle path already resolves to thatdirectory and the reference expanded to a non-existent
src/src/Controller.php;it now points at
@WebfactoryNewsletterRegistrationBundle/Controller.php.The entity classes were referenced under
AppBundle\Entity\*in theresolve_target_entitiesmapping, the service definitions and the"Adding fields" section, while the shipped templates declare them under
AppBundle\Newsletter\Entity\*. All references now use the latternamespace consistently, and the template copy target and Doctrine mapping
directory (
src/AppBundle/Newsletter/Entity/) match it as well.Further corrections:
%kernel.root_dir%(removed after Symfony 4) isreplaced by
%kernel.project_dir%; the//labels inside YAML blocksare turned into valid
#comments; thebundles.phppath is no longerprefixed with
src/, which is a project-specific convention rather thana Symfony default; the
RecpientFactoryInterfacetypo is corrected toRecipientFactoryInterface; and a couple of grammar and naminginconsistencies are cleaned up.
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com