search

dediagency / sylius-seo-plugin

Sylius SEO Plugin by Dedi.
26 stars 24 forks source link

chore(doc): correctif documentation #1

Closed JulienLoison closed 3 years ago

JulienLoison commented 3 years ago

composer require dedi/sylius-seo-plugin requires --no-scripts, without that, it results in exception "You have requested a non-existent parameter "dedi_sylius_seo_plugin.model.seo_content.class"

Updated the documentation to add the "--no-scripts" arguments. The error should be further investigated.

Models customization does not contain extends BaseProduct/BaseChannel, which can lead to confusion layout.html.twig customization description is... lazy. You should either explain in details that the @SyliusShop/layout.html.twig should be overridden or use an existing template event to inject your events

Added some details about template overrides and moved all template overrides in the same part of the documentation.

Throwing an event in title block does not work and results in weird title with HTML code instead (it's only in dev/test environment, but still looks weird and I'm not sure it works)title-event.png

The way we override the block title part should be changed so that we don't need to fully override the <head> part. In _title.html.twig, we should remove the <link> tags and let the layout.html.twig declare it.

"And that's all!" - it suggests that it's the end of the installation process, but in fact, there are a few more required steps (without them, exceptions about missing properties are thrown)

Removed the Bugs Bunny reference.

  • Missing migration application step - there is only
  • Usage of SeoAwareChannelTrait in Channel entity and RichSnippetProductSubjectTrait in Product entity is required There is a step for migration generation, but not for its application (doctrine:migrations:migrate)

Moved the object extensions before the twig override to make it more mandatory when reading the documentation.