adeo / mozaic-design-system

Mozaic Design System
https://mozaic.adeo.cloud
Apache License 2.0
68 stars 17 forks source link

docs(configuration): add documentation about mozaic.config.js #1594

Closed AdeoRemiDoolaeghe closed 1 week ago

AdeoRemiDoolaeghe commented 2 weeks ago

I have read the contributing guidelines

Does this PR introduce a breaking change?

Describe the changes

Explains how to define the Mozaic configuration file, depending on your module system (ESM/CommonJS)

GitHub issue number or Jira issue URL: N/A

Other information

I'm clearly open to changes, as I had to make choices on my own that could not fit very well with the Mozaic way. Don't hesiate to propose changes

AdeoRemiDoolaeghe commented 1 week ago

That's a good idea to rethink how my proposition is organized.

As I'm not sure to understand precisely what you meant, I'll try to rephrase, so you can confirm or not.

Your suggestion is adding a new paragraph before the one called mozaic.config.js to explain the two modules systems, and how it impacts the naming of the file. Then, keep the rest of the documentation as before. Is that it?

dmartinds commented 1 week ago

exactly what you said @AdeoRemiDoolaeghe 👍

AdeoRemiDoolaeghe commented 1 week ago

I've made a new proposition. Don't hesitate to propose changes this time too.

dmartinds commented 1 week ago

👏 Great contribution !

All good for me.