Document CSS and frontend asset build workflow#505
Conversation
| @@ -0,0 +1,52 @@ | |||
| Building CSS and frontend assets | |||
There was a problem hiding this comment.
PR #16143 migrates Mautic from LESS + Grunt to SCSS built with SymfonyCasts Sass Bundle. Key commands added: composer sass:build, composer sass:watch. Bootstrap now comes from twbs/bootstrap-sass Composer package instead of npm.
Source: mautic/mautic#16143
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
|
Done! I've addressed all the review feedback:
|
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
|
Done! Added |
|
Thanks for the follow-up! This is already addressed in the latest commit (d6638df). The phrase "finalized assets" on line 62 refers to general frontend assets (CSS/JS files), not the Mautic Assets feature, so I wrapped it in Let me know if you have any other concerns! |
|
Fixed! Added vale directives around the "Importmap" term since it's a standard web/Symfony technical term for JavaScript module import maps. |
|
Thanks for the suggestion! I've added "Importmap" to the Vale vocabulary file and removed the vale directives around that term. This is a cleaner approach than using inline vale statements. |
|
@promptless-for-oss please rebase to 7.2 branch |
Document the SCSS build workflow using SymfonyCasts Sass Bundle that replaces the previous Grunt/LESS approach. Covers development commands (sass:build, sass:watch), production asset generation, Bootstrap source location, and Symfony Asset Mapper architecture.
- Capitalize "Assets" when referring to Mautic feature - Capitalize "UI Components" in intro text - Add vale off/on directives around SCSS heading and general asset text - Replace "recompiles" with "rebuilds CSS automatically" - Clarify Asset Mapper compilation output locations
Address reviewer feedback to add vale off/on around the "Building Assets for production" heading.
Wrap the Asset architecture section heading and the paragraph containing "Importmap" with vale off/on directives to suppress the Vale spelling error.
Add "Importmap" to the Vale accept.txt vocabulary file since it's a standard web/Symfony technical term. Remove the vale off/on statements that were wrapping references to Importmap in the building_assets.rst documentation.
94cf806 to
97ff276
Compare
|
Done! I've rebased the branch onto |
All uses of 'asset' in building_assets.rst refer to Symfony's Asset Mapper and generic frontend assets (CSS, JavaScript files), not Mautic's Asset feature (downloadable marketing files). Use lowercase consistently per reviewer feedback. Renamed the 'Asset architecture' section to 'Asset Mapper architecture' for clarity.
|
Good catch! All uses of "asset" in this file refer to Symfony's Asset Mapper and generic frontend assets (CSS, JavaScript files), not Mautic's "Asset" feature (downloadable marketing files). I've updated the document to use lowercase "assets" consistently for the Symfony frontend concept, and renamed the section heading from "Asset architecture" to "Asset Mapper architecture" to make the distinction clearer. The capitalized "Asset Mapper" is retained since that's the proper name of the Symfony component. |
Adds vale directives to suppress linting for the paragraph where "assets" refers to generic Symfony frontend assets rather than Mautic's downloadable files feature.
|
Thanks @adiati98! I've applied your suggestion and wrapped the paragraph in |
Open this suggestion in Promptless to view citations and reasoning process
Add documentation for the new SCSS build workflow using SymfonyCasts Sass Bundle, replacing the previous Grunt/LESS approach. Covers development commands (sass:build, sass:watch), production asset generation, and Symfony Asset Mapper architecture.
Trigger Events
Tip: Tell your friends working on non-commercial open-source projects to apply for free Promptless access at promptless.ai/oss ❤️