Document CSS and frontend asset build workflow#505
Conversation
adiati98
left a comment
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
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 |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
|
Hi @adiati98, thanks for the review! I've applied all three suggestions — the affected passages (the production build intro, the build-result description, and the |
|
Geez, I'm on the wrong window! Sorry for the confusion! 😅 This is good to go once @andersonjeccel reviewed the content. 👍🏼 |
|
Can you please review the content here, @andersonjeccel? TIA! ✨ |
|
/aside Can you please review the content here, @andersonjeccel? TIA! ✨ |
Address @adiati98 review: the Mautic.FeatureList rule flags 'assets' in the page title, but here it means compiled frontend build output, not the Mautic Asset feature. A '.. vale off' block alone couldn't scope the document's H1 (Vale promotes the first title to the doc title), so add a leading RST comment inside the suppressed region so the '.. vale off'/'.. vale on' pair covers the title. Vale is now clean on the file.
|
Thanks, @adiati98 — addressed the In this context "assets" refers to the compiled frontend build artifacts (CSS/JS via the Sass bundle and Asset Mapper), not the Mautic Asset content feature, so capitalizing to "Assets" would be incorrect. I suppressed the false positive instead. Vale now reports clean (0/0/0) and the update is pushed to this PR. |
…positive Remove the explanatory RST comment note per @adiati98's request. A .. vale off on the first line of the file does not suppress the Mautic.FeatureList finding on 'assets' in the H1 title (reproduced on Vale 3.7.1 and 3.15.1), which is why the note was priming it. Reword the title to 'Building CSS and frontend files' so it no longer trips the rule, dropping the note and the ineffective top wrap. All other generic 'assets' prose stays lowercase inside working vale off/on blocks.
|
Thanks @adiati98 — removed the note. On the title: I confirmed that a All other generic 'assets' occurrences in the body remain lowercase inside working |
3 participants
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 ❤️