website: re-generate commons to 3.9.2

Author: ilg-ul

README.md

@@ -1,5 +1,6 @@
 
 [![license](https://img.shields.io/github/license/xpack/xpack.github.io)](https://github.com/xpack/xpack.github.io/blob/website/LICENSE)
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fxpack.github.io%2Fxpack.github.io%2F)](https://xpack.github.io/)
 
 # The xPack Project website source
 

website/.gitignore

@@ -1,12 +1,14 @@
+# DO NOT EDIT!
+# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
+
 # Dependencies
 /node_modules
 
 # Production
 /build
 
 # Generated files
-.docusaurus
-.cache-loader
+/.docusaurus
 
 # Misc
 .DS_Store
@@ -18,3 +20,5 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+/tsdoc/doc-model/*.bak

website/docs/_common/_branches-details.mdx

@@ -6,14 +6,12 @@
 <details>
 <summary>Branches</summary>
 
-The project uses multiple branches:
+This project utilises multiple branches:
 
 - `master`, not actively used
-- `webpreview`, with the current development version
-- `website`, with the current content of the website; pushes to this branch automatically trigger publishes the main website
-- `webpreview`, with the current content of the preview website; pushes to this branch automatically trigger publishes the preview website
+- `webpreview`, containing the current development version
 
-All development is done in the `webpreview` branch, and contributions via
+All development is conducted in the `webpreview` branch, and contributions via
 Pull Requests should be directed to this branch.
 
 When new releases are published, the `webpreview` branch is merged

website/docs/_common/_build-website-locally.mdx

@@ -5,10 +5,10 @@
 
 ### Build the static website locally
 
-Validate the website content in a local build via the npm **build** script:
+Validate the website content by performing a local build using the npm **build** script:
 
 ```sh
-npm run build -C website
+npm --prefix ~/Work/xpack/xpack.github.io.git/website run build
 ```
 
-Fix any broken links, if any.
+Resolve any broken links that may be identified during the build process.

website/docs/_common/_code-formatting.mdx

@@ -5,24 +5,24 @@
 
 ## Code formatting
 
-As formatting style, the library uses a
+For formatting style, the library employs a
 [.clang-format](https://clang.llvm.org/docs/ClangFormat.html)
 configuration file based on the GNU style.
 
-Code formatting is done using `clang-format --style=file`, either manually
-from a script, or automatically from Visual Studio Code, or the Eclipse
+Code formatting is performed using `clang-format --style=file`, either manually
+via a script, or automatically through Visual Studio Code, or the Eclipse
 CppStyle plug-in.
 
 :::info
 
-Visual Studio Code can directly utilise the `.clang-format` file in the
+Visual Studio Code can directly utilise the `.clang-format` file within the
 **Format Document** command.
 
 :::
 
 :::tip
 
-Always reformat the source files that were changed before committing
+Always reformat the source files that have been modified before committing
 them to the repository.
 
 :::

website/docs/_common/_continuous-integration.mdx

@@ -3,13 +3,8 @@
 
 {/* ------------------------------------------------------------------------ */}
 
-The library undergoes continuous integration (CI) testing with every
-push using [GitHub Actions](https://github.com/xpack/xpack.github.io/actions).
+The library is subject to continuous integration (CI) testing with every
+push utilising [GitHub Actions](https://github.com/xpack/xpack.github.io/actions).
 This ensures compatibility and stability across Ubuntu, macOS, and Windows
 operating systems.
 
-The tests are conducted on both 32-bit and 64-bit bare-metal platforms,
-including Arm Cortex-M0, Cortex-M3, Cortex-M4F, Cortex-M7F, Cortex-A15,
-Cortex-A72, RISC-V RV32IMAC, and RV64IMAFDC. Additionally, native
-testing is performed using GCC and LLVM/clang compilers, ensuring
-thorough validation across various environments.

website/docs/_common/_generate-top-commons.mdx

@@ -5,14 +5,14 @@
 
 ### Generate the top commons
 
-Run the top **generate-top-commons** npm script to update the
+Execute the top **generate-top-commons** npm script to update the
 `build-assets/package.json` and the GitHub workflow files.
 
 ```sh
-(cd ~/Work/xpack/xpack.github.io.git; npm run generate-top-commons)
+npm --prefix ~/Work/xpack/xpack.github.io.git run generate-top-commons
 ```
 
 ### Commit the top changes
 
-- stage GitHub workflows and `package.json` files (top and from `build-assets`)
-- **commit** with the message _**re-generate top commons to bump deps**_
+- Stage GitHub workflows and `package.json` files (top and from `build-assets`)
+- **Commit** with the message _**re-generate top commons**_

website/docs/_common/_generate-website-commons.mdx

@@ -3,11 +3,16 @@
 
 {/* ------------------------------------------------------------------------ */}
 
-### Update the website commons
+### Generate the website commons
 
-Run the **generate-website-commons** npm script from `website/package.json`
-in the project folder.
+Execute the **generate-website-commons** npm script from `website/package.json`
+within the project folder.
 
 ```sh
-npm run generate-website-commons -C website
+npm --prefix ~/Work/xpack/xpack.github.io.git/website run generate-website-commons
 ```
+
+### Commit the website changes
+
+- Stage the `website` folder and top `README.md`
+- **Commit** with the message _**re-generate website commons**_

website/docs/_common/_get-helper-sources-details.mdx

@@ -6,11 +6,11 @@ import CodeBlock from '@theme/CodeBlock';
 {/* ------------------------------------------------------------------------ */}
 
 <details>
-<summary>Get the writable helper sources (optional, for development purposes)</summary>
+<summary>Obtain the writable helper sources (optional, for development purposes)</summary>
 
-The project has a dependency to a common helper, that is normally installed
-as a read-only dependency; for development purposes, to be able to make
-changes to the scripts located inside the helper, clone the
+The project has a dependency on a common helper, which is normally installed
+as a read-only dependency; for development purposes, to enable modifications
+to the scripts located within the helper, clone the
 <code>{props.helperBranchName}</code> branch and link it to the
 user's global xPacks store:
 
@@ -23,13 +23,13 @@ git clone \\
 \  ~/Work/${props.helperOrganizationName}/${props.helperProjectName}.git \
 `} </CodeBlock>
 
-Or, if the repo was already cloned:
+Alternatively, if the repository has already been cloned:
 
 <CodeBlock language="sh"> {
 `git -C ~/Work/${props.helperOrganizationName}/${props.helperProjectName}.git pull
 `} </CodeBlock>
 
-If a writable instance of this library is needed in another project,
+If a writable instance of this library is required in another project,
 add a link from the user's global xPacks store to it:
 
 <CodeBlock language="sh"> {

website/docs/_common/_get-project-sources.mdx

@@ -5,15 +5,15 @@ import BranchesDetails from './_branches-details.mdx'
 
 {/* ------------------------------------------------------------------------ */}
 
-## Get project sources
+## Obtain project sources
 
 The project is hosted on GitHub:
 
 - https://github.com/xpack/xpack.github.io.git
 
 <BranchesDetails />
 
-To clone the stable branch (`website`), run the following commands in a
+To clone the stable branch (`website`), execute the following commands in a
 terminal (on Windows use the _Git Bash_ console):
 
 ```sh
@@ -39,32 +39,32 @@ git clone \
 
 </details>
 
-Or, if the repo was already cloned:
+Alternatively, if the repository has already been cloned:
 
 ```sh
 git -C ~/Work/xpack/xpack.github.io.git pull
 ```
 
 :::tip
 
-To contribute Pull Requests, fork the project and be sure the **Copy the master branch only** is **disabled**.
+To contribute Pull Requests, fork the project and ensure the **Copy the master branch only** is **disabled**.
 
-Use the `xpack-development` branch and be sure you contribute the
-Pull Requests back to the `xpack-development` branch.
+Utilise the `webpreview` branch and ensure you contribute the
+Pull Requests back to the `webpreview` branch.
 
 :::
 
 ## Add links for development
 
-During development, it is convenient to have a writable instance of the
-module to make changes in parallel with the parent project.
+During development, it is convenient to maintain a writable instance of the
+module to enable changes in parallel with the parent project.
 
 To facilitate the use of a writable instance of this library in other
-projects, add a link from the user's global xPacks store to this local
+projects, add a link from the user's global npm store to this local
 development folder:
 
 ```sh
-npm link -C ~/Work/xpack/xpack.github.io.git
+npm --prefix ~/Work/xpack/xpack.github.io.git link
 ```
 
 And in the projects referring it: