Skip to content

Commit 3a6c9fe

Browse files
committed
website: updates and final common rework
1 parent 85ccad6 commit 3a6c9fe

File tree

8 files changed

+33
-18
lines changed

8 files changed

+33
-18
lines changed
+3
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11

22
{/* ------------------------------------------------------------------------ */}
3+
4+
The project documentation is currently available exclusively on
5+
the project's [website](https://xpack.github.io/).
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
import versionMajor from '@site/src/libs/versionMajor';
3+
import versionMinor from '@site/src/libs/versionMinor';
4+
5+
{/* ------------------------------------------------------------------------ */}
6+
7+
## Release schedule
8+
9+
There are no scheduled releases; the project adheres to a continuous
10+
release approach, with updates deployed as development progresses.

website/docs/getting-started/_common/_license.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## License
77

8-
The original content is released under the
8+
Unless otherwise stated, the original content is released under the terms of the
99
[MIT License](https://opensource.org/license/mit/),
10-
with all rights reserved to
10+
with all rights reserved by
1111
[Liviu Ionescu](https://github.com/ilg-ul).

website/docs/getting-started/index.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ keywords:
99
- xpack
1010
- xpack.github.io
1111
- overview
12+
- features
13+
- benefits
1214
- compatibility
15+
- documentation
1316

14-
date: 2024-10-24 18:58:00 +0300
17+
date: 2020-07-21 17:49:00 +0300
1518

1619
---
1720

website/docs/project/about/_common/_the-author.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ and Internet technologies.
1414
He can be reached at [`<ilg@livius.net>`](mailto:ilg@livius.net).
1515
Please note, this email address is provided as a courtesy.
1616
For all correspondence related to the
17-
**xPack Project** projects, kindly use the support pages of each individual project).
17+
**xPack Project** projects, kindly use the support pages of each individual project.

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ in JavaScript, but a step-by-step approach was later considered.
173173
In the first step, existing build system generators like **CMake**
174174
and **Meson** were used, offering several advantages:
175175

176-
177176
- They allow tests to be added to the µOS++ projects immediately,
178177
without waiting for any special or future tools.
179178
- They provide a valuable opportunity to gain experience in
@@ -239,7 +238,7 @@ plain text editor.
239238

240239
## Conclusions
241240

242-
As can be seen, the xPack Project originated from **the need to
241+
The xPack Project originated from **the need to
243242
automate the workflow for existing open-source projects**, particularly
244243
the execution of multiple tests for embedded projects, which often poses
245244
more challenges than developing the projects themselves.

website/docs/support/index.mdx

+12-11
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,14 @@ pages for the specific project you're interested in.
3232

3333
## Web pages issues
3434

35-
If you find any issues in the content of these pages (such as typos or
35+
If you encounter any issues in the content of these pages (such as typos or
3636
incorrect phrasing) or have suggestions for improving the documentation,
3737
please share them through the
3838
GitHub Discussions pages. Use the top-level
3939
[GitHub Discussions](https://github.com/xpack/xpack.github.io/discussions)
4040
page for issues related to the main xPack Project site, or the individual project's GitHub Discussions pages for specific projects.
41+
Be sure you provide the full URL of the page, clearly identify the
42+
part with the problematic section, and suggest improvements.
4143

4244
## Check documentation
4345

@@ -62,14 +64,14 @@ for similar problems.
6264

6365
## Ask questions in GitHub Discussions
6466

65-
If you still could not find a solution, if you have interesting use
66-
cases, if you have custom configurations, and generally if you have
67-
any experience that you want to share with others,
67+
If you still cannot find a solution, have interesting use cases,
68+
custom configurations, or any experiences you wish to share with
69+
others, please
6870
use the top-level
6971
[GitHub Discussions](https://github.com/xpack/xpack.github.io/discussions)
7072
page for questions related to the top xPack Project. For specific projects,
7173
use the individual project's GitHub Discussions pages.
72-
Enter a **New discussion**; use the **Q&A** category for questions,
74+
Start a **New discussion**; use the **Q&A** category for questions,
7375
**Ideas** for suggestions and **General** for everything else.
7476

7577
## Stack Overflow
@@ -113,13 +115,12 @@ Follow the hashtag `#xpack_project` for the latest updates.
113115
:::caution Please, please, please!
114116

115117
**Do not** use
116-
private e-mail for support, **use the
118+
private e-mail for support; instead, **use the
117119
[GitHub Discussions](https://github.com/xpack/xpack.github.io/discussions)** pages.
118120

119121
:::
120122

121-
Sending private messages will be automatically replied with
122-
a short message including a link to this page.
123-
The reason for this rude behaviour is simply an attempt to use
124-
the time more efficiently; since discussions are archived, other people
125-
having similar problems might benefit from the answers.
123+
Private messages will receive an automated reply containing a link
124+
to this page. This approach is not intended to be discourteous, but
125+
rather to optimise time efficiency; as discussions are archived,
126+
others facing similar issues may benefit from the provided answers.

website/src/components/HomepageFeatures/index.tsx

-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import Link from '@docusaurus/Link';
1818
import styles from './styles.module.css';
1919

2020
import type { FeatureItem } from './FeatureItem';
21-
2221
import { FeatureList } from './CustomFeatureList';
2322

2423
function Feature({title, Svg, description}: FeatureItem) {

0 commit comments

Comments
 (0)