Skip to content

Commit 589b601

Browse files
committed
website text fixes
1 parent fea2d9b commit 589b601

6 files changed

Lines changed: 43 additions & 24 deletions

File tree

website/docs/developer/js-style-guide/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22

33
title: JavaScript/TypeScript Style Guide
4-
description: For consistency, use automated validation tools (prettier & ESlint).
4+
description: For consistency, use automated validation tools (prettier & ESLint).
55
keywords:
66
- xpack
77
- javascript
@@ -33,7 +33,7 @@ To ensure consistency in the xPack JavaScript/TypeScript source files, the
3333
primary requirements are:
3434

3535
- use [prettier](https://prettier.io) for automated re-formatting
36-
- use [ESlint](https://eslint.org) as a validation tool, which also
36+
- use [ESLint](https://eslint.org) as a validation tool, which also
3737
has a TypeScript variant
3838
([typescript-eslint](https://typescript-eslint.io/packages/typescript-eslint/))
3939

website/docs/getting-started/_project/_content.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ and **multi-configuration builds**, in a **reproducible** way.
5959

6060
:::
6161

62-
Based on a straightforward multi-version dependencies manager
62+
Based on a straightforward multi-version dependency manager
6363
built on top of **npm**, the xPack Project aims to provide a
6464
suite of cross-platform tools. These tools are designed to manage,
6565
**configure**, **build** and **test** complex, modular,
@@ -99,7 +99,7 @@ executed repeatedly with identical results across different
9999
platforms and over time enhances the reliability and stability
100100
of the development process.
101101
3. **Modularity and Flexibility**: The focus on complex, modular
102-
projects allows for better organization and scalability. Developers
102+
projects allows for better organisation and scalability. Developers
103103
can work on individual components without affecting the entire
104104
system, facilitating easier maintenance and updates.
105105
4. **Cross-Platform Compatibility**: Tools designed to work across
@@ -108,7 +108,7 @@ project can be adapted to different environments, making it
108108
versatile and adaptable to various development needs.
109109
5. **Specialization in C/C++ and Bare-Metal Embedded Projects**:
110110
By targeting specific areas like C/C++ and bare-metal embedded
111-
projects, the tools can offer specialized features and optimizations
111+
projects, the tools can offer specialised features and optimisations
112112
that cater to the unique requirements of these domains.
113113
6. **Improved Code Sharing and Reuse**: The use of a multi-version
114114
dependencies manager built on top of npm promotes better code sharing

website/docs/getting-started/prerequisites/_use-nvm.mdx

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import Heading from '@theme/Heading';
2+
import CodeBlock from '@theme/CodeBlock';
23

34
{/* ------------------------------------------------------------------------ */}
45

@@ -36,20 +37,37 @@ should review the content of the file before executing it.
3637

3738
If you trust the script, you can use the following shortcut:
3839

39-
```sh
40-
curl https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh | bash
40+
{props.os === 'macos' ? (
41+
<CodeBlock language="sh">
42+
{`curl --fail --silent --show-error --location https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh | \${SHELL}
4143
42-
export NVM_DIR="${HOME}/.nvm"
43-
source "${NVM_DIR}/nvm.sh"
44-
```
44+
export NVM_DIR="\${HOME}/.nvm"
45+
source "\${NVM_DIR}/nvm.sh"`}
46+
</CodeBlock>
47+
) : (
48+
<CodeBlock language="sh">
49+
{`wget --quiet --output-document=- https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh | \${SHELL}
50+
51+
export NVM_DIR="\${HOME}/.nvm"
52+
source "\${NVM_DIR}/nvm.sh"`}
53+
</CodeBlock>
54+
)}
4555

4656
Otherwise download and check the script:
4757

48-
```sh
49-
mkdir -pv "${HOME}/Downloads/"
50-
curl --output "${HOME}/Downloads/install-nvm-node-npm-xpm.sh" https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh
51-
cat "${HOME}/Downloads/install-nvm-node-npm-xpm.sh"
52-
```
58+
{props.os === 'macos' ? (
59+
<CodeBlock language="sh">
60+
{`mkdir -pv "\${HOME}/Downloads/"
61+
curl --output "\${HOME}/Downloads/install-nvm-node-npm-xpm.sh" https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh
62+
cat "\${HOME}/Downloads/install-nvm-node-npm-xpm.sh"`}
63+
</CodeBlock>
64+
) : (
65+
<CodeBlock language="sh">
66+
{`mkdir -pv "\${HOME}/Downloads/"
67+
wget --quiet --output-document="\${HOME}/Downloads/install-nvm-node-npm-xpm.sh" https://raw.githubusercontent.com/xpack/assets/master/scripts/install-nvm-node-npm-xpm.sh
68+
cat "\${HOME}/Downloads/install-nvm-node-npm-xpm.sh"`}
69+
</CodeBlock>
70+
)}
5371

5472
When confident, run it:
5573

@@ -66,7 +84,8 @@ This script will install `nvm` (the Node Version Manager), `node`,
6684

6785
To automatically activate `nvm`, the script adds several lines
6886
to the shell initialization script. Therefore, it is necessary
69-
to restart the shell to apply these changes.
87+
to restart the shell to apply these changes or to manually
88+
export `NVM_DIR` and source the script.
7089

7190
:::
7291

website/docs/getting-started/prerequisites/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import VersionManager from './_version-manager.mdx';
3939

4040
## Overview
4141

42-
All xPack core tools are [Node.js](https://nodejs.org) CLI application
42+
All xPack core tools are [Node.js](https://nodejs.org) CLI applications
4343
available from the
4444
[npmjs.com](https://www.npmjs.com) public repository. They can be installed
4545
via `npm`, which runs on top of **Node.js**.
@@ -60,7 +60,7 @@ If this is your first time using **npm**, you'll need to install the
6060
[Node.js](https://nodejs.org) ECMAScript (JavaScript) runtime.
6161
The installation process is
6262
straightforward and does not clutter system locations.
63-
There are two versions of Node.js: **LTS** (**Long Term Service**) and
63+
There are two versions of Node.js: **LTS** (**Long Term Support**) and
6464
**Current**. Generally, it is safer to use the **LTS** version,
6565
especially on Windows.
6666

@@ -204,7 +204,7 @@ While not mandatory for using the xPack tools alone, it is recommended
204204
to install the [Git for Windows](https://git-scm.com/download/win) package too.
205205

206206
This also installs a `bash` shell.
207-
The xPack Core Tools can run either in either the Windows shells or in the Git `bash` shell.
207+
The xPack Core Tools can run in either the Windows shells or in the Git `bash` shell.
208208

209209
<Heading as="h2">Visual C++ Redistributable Files</Heading>
210210

@@ -276,7 +276,7 @@ For further information, please refer to the Microsoft documentation, such as th
276276
For macOS, it is
277277
**strongly recommended** to **use a version manager** (see below).
278278

279-
<UseNvm />
279+
<UseNvm os="macos"/>
280280

281281
<Heading as="h2">Command Line Tools</Heading>
282282

@@ -400,12 +400,12 @@ default -> 20 (-> v20.18.0)
400400
For GNU/Linux, it is
401401
**strongly recommended** to **use a version manager** (see below).
402402

403-
<UseNvm />
403+
<UseNvm os="linux"/>
404404

405405
:::info
406406

407407
Arm platforms, like the Raspberry Pi,
408-
are supported, currently in both 32/64-bit variants.
408+
are supported, currently only in 64-bit mode.
409409

410410
:::
411411

website/docs/project/about/_project/_content.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ various individual projects, including tools, npm modules, and
1414
platform-specific executables. All these projects are hosted on
1515
GitHub under two groups (or
1616
_organizations_ in GitHub parlance): [xpack](https://github.com/xpack/) and
17-
[xpack-dev-tools](ttps://github.com/xpack-dev-tools/).
17+
[xpack-dev-tools](https://github.com/xpack-dev-tools/).
1818

1919
<TheProjectHistory />
2020

website/docs/project/about/_project/_website.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The **xPack Project** web site was created in **October 2017**, using a home
99
grown GitHub-like theme; however, for a while there was not much content.
1010

1111
In **June 2019** it was reworked to use a
12-
more elaborated theme,
12+
more elaborate theme,
1313
[Jekyll Doc Theme 6.0](https://idratherbewriting.com/documentation-theme-jekyll/)
1414
by [Tom Johnson](https://github.com/tomjoht).
1515

0 commit comments

Comments
 (0)