Merge pull request #566 from smapiot/feature/documentation-typos-gram…

…mar-and-fixes

Documentation: Fix Typos, Grammar and Small Crumbs

.github/CONTRIBUTING.md

@@ -14,11 +14,11 @@ This project and everyone participating in it is governed by the [Code of Conduc
 
 ### Development Instructions
 
-Please find more information about how to setup your machine for developing Piral in [the source documentation](../src/README.md).
+Please find more information about how to set up your machine for developing Piral in [the source documentation](../src/README.md).
 
 ### Reporting Bugs
 
-Before creating bug report, please make sure that you first check the [existing issues](https://github.com/smapiot/piral/issues?q=is%3Aopen+is%3Aissue+label%3Abug), as you might find that the issue is already reported. Fill out [the required template](https://github.com/smapiot/piral/issues/new?template=bug_report.md), the information it asks for helps us resolve issues faster.
+Before creating a bug report, please make sure that you first check the [existing issues](https://github.com/smapiot/piral/issues?q=is%3Aopen+is%3Aissue+label%3Abug), as you might find that the issue is already reported. Fill out [the required template](https://github.com/smapiot/piral/issues/new?template=bug_report.md), the information it asks for helps us resolve issues faster.
 
 Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:.
 
@@ -35,7 +35,7 @@ Enhancements or general suggestions are tracked as [GitHub issues](https://docs.
 - **Use a clear and descriptive title** for the issue to identify the suggestion.
 - **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
 - **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
-- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Piral which the suggestion is related to. *Note*: We usually live in code. Any code you can already show would be the best illustration.
+- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Piral to which the suggestion is related. *Note*: We usually live in code. Any code you can already show would be the best illustration.
 
 ## Branching Model
 
@@ -56,18 +56,18 @@ The **documentation** branch is used for updates and fixes to the currently live
 
 The following table gives an overview:
 
-| Branch Name   | Builds Documentation | NPM Release / Tag | Version Suffix |
-| ------------- | -------------------- | ----------------- | -------------- |
-| main          | yes (indirectly)     | latest            | (none)         |
-| develop       | no                   | next              | beta           |
-| experimental  | no                   | canary            | alpha          |
-| documentation | yes                  | (none)            | (none)         |
+| Branch Name   | Builds Documentation | NPM Release/Tag | Version Suffix |
+| ------------- | -------------------- | --------------- | -------------- |
+| main          | yes (indirectly)     | latest          | (none)         |
+| develop       | no                   | next            | beta           |
+| experimental  | no                   | canary          | alpha          |
+| documentation | yes                  | (none)          | (none)         |
 
-If you don't know what to do - use `develop` as target for pull requests.
+If you don't know what to do - use `develop` as a target for pull requests.
 
 ### Supporting Branches
 
-Next to the main branches `main` and `develop`, our development model uses a few of supporting branches to aid parallel development between team members, ease tracking of features and to assist in quickly fixing live production problems. Unlike the main branches, these branches always have a limited life time, since they will be removed eventually.
+Next to the main branches `main` and `develop`, our development model uses a few supporting branches to aid parallel development between team members, ease tracking of features, and assist in quickly fixing live production problems. Unlike the main branches, these branches always have a limited lifetime, since they will be removed eventually.
 
 The two main different types of branches we may use are:
 
@@ -85,20 +85,20 @@ Naming convention:
 
 #### Creating a Hotfix Branch
 
-Create a branch **from** `main` which must merge back **into** either `main` and / or `develop`. While a *real* hotfix will apply to both immediately, a simple fix will just be applied to `develop`.
+Create a branch **from** `main` which must merge back **into** either `main` and/or `develop`. While a *real* hotfix will apply to both immediately, a simple fix will just be applied to `develop`.
 
 Naming convention:
 
 - `hotfix/{new-patch-version}`, e.g., `hotfix/1.2.1`
 - `hotfix/{issue-id}-{issue-description}`, e.g., `hotfix/#123-fixed-foo-undefined`
 
-Hotfix branches are normally created from the `main` branch (especially if they are applied to both `main` and `develop`, otherwise creating the branch from `develop` may be okay as well). For example, say version 1.2 is the current production release running live and causing troubles due to a severe bug. But changes on develop are yet unstable.
+Hotfix branches are normally created from the `main` branch (especially if they are applied to both `main` and `develop`, otherwise creating the branch from `develop` may be okay as well). For example, say version 1.2 is the current production release running live and causing troubles due to a severe bug, while changes on develop are yet unstable.
 
 ## Pull Request Process
 
 Following is a short guide on how to make a valid Pull Request.
 
-1. Firstly you need a local fork of the the project, so go ahead and press the `fork` button in
+1. Firstly you need a local fork of the project, so go ahead and press the `fork` button in
    GitHub. This will create a copy of the repository in your own GitHub account and you'll see a
    note that it's been forked underneath the project name: `Forked from smapiot/piral`.
    Clone the newly forked repository locally and set up a new remote that points to the original
@@ -111,15 +111,15 @@ Following is a short guide on how to make a valid Pull Request.
    You now have two remotes for this project on disk:
 
    1. `origin` which points to your GitHub fork of the project.
-      You can read and write to this remote.
+      You can read and write on this remote.
    2. `upstream` which points to the main project's GitHub repository.
       You can only read from this remote.
 
 2. Create the branch, following or [Branching Model](#branching-model).
 
 3. Do some work :) This is the fun part where you get to contribute to Piral :rocket:.
 
-4. Before pushing your code, few more task that need to be preformed:
+4. Before pushing your code, there are a few more tasks that need to be performed:
 
    - Make sure that the test and build scripts run successfully
 
@@ -141,4 +141,4 @@ Following is a short guide on how to make a valid Pull Request.
    [Piral repository](https://github.com/smapiot/piral/pulls) and issue a new pull
    request.
 
-You may merge the Pull Request in once you have the sign-off of at least one other (core) developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.
+You may merge the Pull Request once you have the sign-off of at least one other (core) developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -37,6 +37,6 @@ For more information, see the `CONTRIBUTING` guide.
 
 [What actually happened]
 
-## Possible Origin / Solution
+## Possible Origin/Solution
 
 [Optionally, share your idea to fix the issue]

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Piral Changelog
 
+## 0.15.3 (tbd)
+
+- Added support for Blazor custom elements in `piral-blazor`
+
 ## 0.15.2 (December 5, 2022)
 
 - Fixed import of common module in CommonJS build of `piral-ng`
@@ -144,7 +148,7 @@
 
 - Updated dependencies
 - Fixed issue with `pilet build` of `--type standalone` when using importmap
-- Added `CUSTOM_ELEMENTS_SCHEMA` to default / fallback module in `piral-ng`
+- Added `CUSTOM_ELEMENTS_SCHEMA` to default/fallback module in `piral-ng`
 - Added automatic module cleanup on pilet teardown
 
 ## 0.14.19 (March 20, 2022)
@@ -778,7 +782,7 @@
 
 - Fixed bug in Piral CLI preventing to reference external resources
 - Fixed bug in Piral CLI that prevented immediate exit
-- Improved the `createPiral` function signature / behavior
+- Improved the `createPiral` function signature/behavior
 - Added `SetRedirect` component for declaring redirects
 
 ## 0.8.1 (October 23, 2019)

CODE_OF_CONDUCT.md

@@ -2,7 +2,7 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -26,7 +26,7 @@ Examples of unacceptable behavior by participants include:
 
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 

SECURITY.md

@@ -9,7 +9,7 @@
 
 ## Reporting a Vulnerability
 
-If you find a vulnerability use the [GitHub issue tracker](https://github.com/smapiot/piral/issues) to inform us quickly.
+If you find a vulnerability, use the [GitHub issue tracker](https://github.com/smapiot/piral/issues) to inform us quickly.
 
 Security critical bugs get the highest possible priority and should be released within some hours (business days) to at most a day (weekends).
 

docs/README.md

@@ -1,10 +1,10 @@
 # Piral Documentation
 
-Piral is a React-based framework that tries to help you building a modular single page application (SPA) following the micro frontends architecture. Like every good library Piral tries to
+Piral is a React-based framework that tries to help you build a modular single page application (SPA) following the micro frontends architecture. Like every good library, Piral tries to
 
 > make the common things simple and make any customizations possible.
 
-Piral is open-source software. We try to make everything as transparent and contribution friendly as possible. This includes the documentation. If you think something is missing or described poorly then let us know (or even better: file directly a pull request with the desired changes).
+Piral is open-source software. We try to make everything as transparent and contribution-friendly as possible. This includes the documentation. If you think something is missing or described poorly then let us know (or even better: file directly a pull request with the desired changes).
 
 ## Available Content
 

docs/browsers.md

@@ -25,7 +25,7 @@ The pilet schema indicates the specification that is followed for packaging and
 The schema is applied at compile-time. So, if you built your pilet using an earlier (pre 0.10) version of Piral then an older schema (v0) was used. A rebuild is necessary to migrate to v1 or v2. The schema can be selected via a command line argument.
 :::
 
-The following browsers are not directly supported by Piral, but have been working up to some extend in the past:
+The following browsers are not directly supported by Piral, but have been working up to some extent in the past:
 
 | Browser           | Version | Notes                      |
 |-------------------|---------|----------------------------|

docs/commands/README.md

@@ -1,6 +1,6 @@
 # Available Commands
 
-The Piral CLI is a command line tool that helps to simplify everyday tasks for making development of a modularized frontend simple and flexible. Instead of writing our own tool from scratch we rely on existing tools that come with their mature ecosystems.
+The Piral CLI is a command line tool that helps to simplify everyday tasks for making the development of a modularized frontend simple and flexible. Instead of writing our own tool from scratch, we rely on existing tools that come with their mature ecosystems.
 
 ## Piral Related Commands
 

docs/concepts/I01-architecture.md

@@ -12,13 +12,13 @@ Piral allows you to layout your application with modularization in mind. Instead
 
 ![Modularization of the Monolith](../diagrams/modularization.svg)
 
-To make creating instances of Piral that effective the architecture of Piral needs to deliver. Let's start with the used building blocks.
+To make creating instances of Piral effective, the architecture of Piral needs to deliver. Let's start with the used building blocks.
 
 ## Building Blocks
 
 Piral does not start from zero. The stack that is used by Piral is React-based. Nevertheless, the API supports any kind of framework, as long as it can work with an arbitrary element to render it into.
 
-Piral itself is based on **React** and its eco-system, e.g., **React DOM** (to render on a website), **React Router** (for routing), **Zustand** (global state container) and a React independent building block **Piral Base** (which allows loading modules at runtime via SystemJS).
+Piral itself is based on **React** and its eco-system, e.g., **React DOM** (to render on a website), **React Router** (for routing), **Zustand** (global state container), and a React independent building block **Piral Base** (which allows loading modules at runtime via SystemJS).
 
 ![Building blocks of Piral](../diagrams/blocks.svg)
 
@@ -36,11 +36,11 @@ The previous diagram shows the different layers contained in a pilet package. Mo
 
 ## Initial Loading
 
-The initial loading of a Piral instance is a multi-stage process. Essentially, compared to a standard React / JavaScript app we inserted the middle three boxes, which render the Piral instance triggering the pilet loading and their eventual integration.
+The initial loading of a Piral instance is a multi-stage process. Essentially, compared to a standard React/JavaScript app we inserted the middle three boxes, which render the Piral instance triggering the pilet loading and their eventual integration.
 
 ![Loading a Piral instance](../diagrams/loading.svg)
 
-Note that while pilets can be loaded from cache as well, we usually require at least one communication with a server to ensure that the cached pilets are the ones that should be loaded for the user. Updates on the pilets, different feature flags and other factors may influence this decision.
+Note that while pilets can be loaded from cache as well, we usually require at least one communication with a server to ensure that the cached pilets are the ones that should be loaded for the user. Updates on the pilets, different feature flags, and other factors may influence this decision.
 
 ## State Management
 
@@ -60,7 +60,7 @@ You can extend and use state management in your Piral instance.
 
 ## Pilet API
 
-When pilets are setup they receive a special kind of object called the `Pilet API`. The `Pilet API` gives pilets access to the Piral instance to set up their components accordingly.
+When pilets are set up, they receive a special kind of object called the `Pilet API`. The `Pilet API` gives pilets access to the Piral instance to set up their components accordingly.
 
 Setting up components may involve setting up dedicated (routes to) pages, tiles on a dashboard, general extensions, modal dialogs, and other components that need to be managed by the Piral instance.
 

docs/concepts/I02-libraries.md

@@ -23,7 +23,7 @@ The following table compares the three from an out-of-the-box feature perspectiv
 | Error Handling   | ️️️✔️    | ️️️✔️     | ✔️    |
 | Error Display    | ️️️❌    | ️️️✔️     | ✔️    |
 | Global State     | ️️️❌    | ️️️✔️     | ✔️    |
-| Pages / Routing  | ️️️❌    | ️️️✔️     | ✔️    |
+| Pages/Routing    | ️️️❌    | ️️️✔️     | ✔️    |
 | Extension API    | ️️️❌    | ️️️✔️     | ✔️    |
 | Shared Data API  | ️️️❌    | ️️️✔️     | ✔️    |
 | Dashboard        | ️️️❌    | ️️️❌    | ✔️    |
@@ -58,7 +58,7 @@ Let's install `piral` (and we are done with the dependencies!):
 npm i piral
 ```
 
-This is it! Really? Well, we have not built, customized, or published this instance yet. Ideally, we use the `piral-cli` to do most of these tasks very efficiently without much configuration needs.
+This is it! Really? Well, we have not built, customized, or published this instance yet. Ideally, we use the `piral-cli` to do most of these tasks very efficiently without much configuration needed.
 
 We should always add the CLI as a *local* **dev** dependency.
 
@@ -70,19 +70,19 @@ To help us see the commands in action we can also use a *global* version of the
 
 ## A Piral-Core Based Application
 
-Here, we will rely on `piral-core`, which can be considered a library. While very special dependencies such as `react-atom` are straight dependencies, common dependencies such as `react` are only peer referenced. This leaves many of the open choices up to the developer providing greater freedom.
+Here, we will rely on `piral-core`, which can be considered a library. While very special dependencies such as `react-atom` are straight dependencies, common dependencies such as `react` are only peer-referenced. This leaves many of the open choices up to the developer providing greater freedom.
 
 ::: warning: Peer dependencies
 You will need to pick (and reference) the versions of `react`, `react-dom`, `react-router`, and `react-router-dom`.
 :::
 
-We recommend using `piral-core` when you want to have more control what (versions of the) dependencies go in and how the API for the pilets look like.
+We recommend using `piral-core` when you want to have more control over what (versions of the) dependencies go in and what the API for the pilets look like.
 
 ## A Piral-Base Based Application
 
-Relying on `piral-base` we can build an application independent of React, state management or anything else - only with the loading and correct interpretation of pilets. This alone would not support *most* Piral plugins. However, the `piral-cli` and pilets in general are supported.
+Relying on `piral-base` we can build an application independent of React, state management, or anything else - only with the loading and correct interpretation of pilets. This alone would not support *most* Piral plugins. However, the `piral-cli` and pilets, in general, are supported.
 
-The result could be a new framework that leverages Piral, but using, e.g., Angular instead of React.
+The result could be a new framework that leverages Piral, while using, for example, Angular instead of React.
 
 ::: tip: Share tslib
 The `piral-base` package has a single dependency: `tslib`. Ideally, you set `importHelpers` to `true` in your *tsconfig.json* and share the dependency to `tslib` from your app shell.