Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #62

Merged
merged 4 commits into from
Mar 25, 2025
Merged

Documentation updates #62

merged 4 commits into from
Mar 25, 2025

Conversation

jwloka
Copy link
Member

@jwloka jwloka commented Mar 24, 2025

This PR focuses on improving the main README.md file and adding license headers to various source files. Additionally, there are minor changes to configuration files. The most important changes are summarized below:

Documentation Updates:

  • README.md: Expanded and clarified instructions for using websmith, including details on installation, configuration, and usage with webpack. Added examples of compiler addons and how to create custom addons. [1] [2] [3]

License Updates:

Configuration Changes:

  • LICENSE: Updated the copyright year from 2024 to 2025.
  • eslint.config.js: Renamed @quatico/websmith-example-addons to @quatico/websmith-examples for consistency.
  • jest.config.ts: Replaced the proprietary license header with the MIT license header.

These changes collectively improve the clarity of the documentation, ensure proper licensing, and maintain consistency across the codebase.

jwloka added 3 commits March 24, 2025 05:11
+ Updates license to 2025
… when and how to use websmith

Introducing Profiles: Replace compilation targets with profiles #55
Introducing Profiles: Replace compilation targets with profiles #55
@jwloka jwloka requested a review from meck93 March 24, 2025 05:55
@jwloka jwloka added the documentation Improvements or additions to documentation label Mar 24, 2025
@jwloka jwloka added this to the 55 milestone Mar 24, 2025
Introducing Profiles: Replace compilation targets with profiles #55
Base automatically changed from 55-introducing-profiles-replace-compilation-targets-with-profiles to develop March 25, 2025 02:40
@jwloka jwloka merged commit 7473094 into develop Mar 25, 2025
2 checks passed
@jwloka jwloka deleted the documentation-updates branch March 25, 2025 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants