Polish packages and documentation for a major release #64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introducing Profiles: Replace compilation targets with profiles #55
… and CLI parameters Introducing Profiles: Replace compilation targets with profiles #55
Introducing Profiles: Replace compilation targets with profiles #55
Introducing Profiles: Replace compilation targets with profiles #55
… to use its API Introducing Profiles: Replace compilation targets with profiles #55
…README file Introducing Profiles: Replace compilation targets with profiles #55
meck93
approved these changes
Mar 26, 2025
There was a problem hiding this comment.
Sieht grundsätzlich i.o. aus. Habe es nur überflogen.
Ich würde es gerne im Detail lesen, wenn es released ist und ich es direkt anwenden kann. Bzw. der Doku folgen kann und versuchen die Schritte gemäss Doku 1:1 direkt selbst anzuwenden. Ok?
Falls es Dokumentationsänderungen gibt können wir ja einen Patch Release machen.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several documentation updates to improve clarity and consistency across the
websmithproject. The most important changes include updates to theREADME.mdfiles for various packages, adjustments to thewebsmithcommand options, and refinements to the addon implementation guidelines.Documentation updates:
README.md: Updated descriptions to emphasize customization of the compilation output rather than the process. This includes changing phrases like "compilation process" to "compilation output" and updating links to the relevant sections. [1] [2] [3] [4] [5] [6]packages/api/README.md: Renamed the package to@quatico/websmith-apiand added detailed descriptions of the addon capabilities and usage examples.packages/api/docs/write-your-own-addon.md: Updated the addon API description to focus on customizing the compilation output and provided clearer instructions for implementing and integrating addons. [1] [2]packages/compiler/README.md: Revised the introduction to highlight thewebsmithcommand as a drop-in replacement fortscwith additional customization options. Added sections on using compiler addons, command line parameters, and defining and activating compilation profiles.packages/core/README.md: Clarified that this package contains shared library functions and is a peer dependency of the@quatico/websmith-compilerpackage.Command options adjustments:
packages/compiler/src/command.ts: Updated the descriptions of the--addonsand--transpileOnlyoptions to reflect that no addons are applied by default, and added a period at the end of the--projectoption's description for consistency.