Document `excluded_paths` when using `propshaft`

[Paul-Bob]

avo-hq/avo#3657

When propshaft is used, rails assets:precompile exports all assets from app/assets to public/assets.

While some users may rely on these assets, the majority will not.

Document the method to exclude them.

Rails.application.config.assets.excluded_paths += [
  Avo::Engine.root.join("app/assets/builds"),
  Avo::Engine.root.join("app/assets/config"),
  Avo::Engine.root.join("app/assets/stylesheets"),
  Avo::Engine.root.join("app/assets/svgs")
]

[alimi]

FYI the shovel operator (<<) won't work because it'll nest the array inside the excluded_paths array. Instead, we probably want to use +=.

Rails.application.config.assets.excluded_paths += [
  Avo::Engine.root.join("app/assets/builds"),
  Avo::Engine.root.join("app/assets/config"),
  Avo::Engine.root.join("app/assets/stylesheets"),
  Avo::Engine.root.join("app/assets/svgs")
]

[alimi]

Would it also be best practice to exclude asset paths from Avo dependencies like Avo::DynamicFilters?

[Paul-Bob]

That is correct, great catch @alimi!

Thanks for pointing it, I'll update the original post