website: updates

xpack-dev-tools · Dec 11, 2024 · c7992e0 · c7992e0
1 parent 6bcb2c6
commit c7992e0
Show file tree

Hide file tree

Showing 9 changed files with 83 additions and 37 deletions.
diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -3,8 +3,8 @@
 # DO NOT EDIT!
 # Automatically generated from xbb-helper/templates/docusaurus/common.
 
-title: Developer Information
-description: Assistance for developers looking to build the packages, including prerequisites, repositories used, and actions for each supported platform.
+title: Contributor's Guide
+description: Guidance for developers aiming to contribute new features or bug fixes, detailing how to build the binaries, including prerequisites, repositories utilised, and scripts.
 keywords:
   - xpack
   - clang
@@ -16,6 +16,8 @@ date: 2024-07-21 20:33:00 +0300
 
 ---
 
+
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
@@ -29,11 +31,12 @@ import More from './_more.mdx'
 
 {/* ------------------------------------------------------------------------ */}
 
-# How to build the xPack LLVM clang
+# How to contribute to the xPack LLVM clang
 
 [![license](https://img.shields.io/github/license/xpack-dev-tools/clang-xpack)](https://github.com/xpack-dev-tools/clang-xpack/blob/xpack/LICENSE)
 
-This page is designed for developers of the
+This page is designed for developers who plan to contribute new features
+or fix bugs in the
 **xPack LLVM clang**
 project and provides documentation on how to build and test the package.
 
@@ -193,7 +196,8 @@ The build scripts run on GNU/Linux and macOS. The Windows binaries are
 compiled on x64 GNU/Linux, using [mingw-w64](https://mingw-w64.org).
 
 For details on installing the prerequisites, please read the
-[XBB prerequisites page](https://xpack.github.io/xbb/prerequisites/).
+[Build Prerequisites](https://xpack-dev-tools.github.io/docs/developer/install/prerequisites/)
+page.
 
 ## Get project sources
 
@@ -244,6 +248,15 @@ git clone \
 
 </details>
 
+:::tip
+
+To contribute Pull Requests, fork the project and be sure 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.
+
+::
+
 <details>
 <summary>Get the writable helper sources (optional, for development purposes)</summary>
 
@@ -345,3 +358,5 @@ https://github.com/xpack-dev-tools/files-cache/tree/master/libs),
 place them in the XBB cache (`Work/cache`) and restart the build.
 
 <More/>
+
+
diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx
@@ -65,22 +65,23 @@ this project also includes the
 
 <UpgradeNotice/>
 
-## xPacks
+## What are xpm packages? (xPacks)
 
-**xPacks** (short for **xpm packages**) are general-purpose,
-language-neutral software packages.
+**xpm packages**, abbreviated as **xPacks**, are versatile,
+language-neutral software packages. They have been successfully
+utilised in C/C++ projects.
 
 <details>
-<summary>What the heck are xPacks? Please, do not introduce another package format!</summary>
+<summary>What the heck are xpm packages / xPacks? Please, do not introduce another package format!</summary>
 
-While the initial appearance may seem complex, utilizing xPacks
-(xpm packages) is, in fact, straightforward.
+While the initial appearance may seem complex, utilizing
+xpm packages is, in fact, straightforward.
 The design rationale is to automate frequent
 operations that occur during software development, in this case the
 installation of
 dependencies, and to ensure reproducibility.
 
-xPacks are managed by **[xpm](https://xpack.github.io/xpm/)**
+These packages are managed by **[xpm](https://xpack.github.io/xpm/)**
 (the xPack Project Manager),
 a program that complements the **[npm](https://docs.npmjs.com/cli/)** CLI
 (the popular JavaScript package manager), with new language-neutral features.
@@ -95,7 +96,7 @@ same repositories as **npm**, whether public or private.
 The packages (usually regular archives, but also git repositories),
 are extracted into separate folders within the project.
 
-Based on the content, there are two types of packages:
+Based on the content, there are two types of xpm packages:
 
 - **source packages** (that install source files, usually libraries) and
 - **binary packages** (that install executables/binary files, usually tools).
@@ -113,8 +114,8 @@ archives, the packages are extracted only once into a user global location to
 conserve space. In projects, instead of duplicating the content of these
 archives, symbolic links are created.
 
-Simply put, xPacks can be used to further automate the installation of source
-libraries and tools.
+Simply put, xpm packages can be used to further automate the
+installation of source libraries and tools.
 
 </details>
 

diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx
@@ -20,6 +20,8 @@ date: 2020-08-21 11:09:00 +0300
 
 ---
 
+
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
@@ -685,3 +687,5 @@ After install, the package creates a hierarchy of folders like the following
 <Miscellaneous/>
 
 <Testing/>
+
+
diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx
@@ -3,20 +3,22 @@
 # DO NOT EDIT!
 # Automatically generated from xbb-helper/templates/docusaurus/common.
 
-title: Maintainer Information
+title: Maintainer's Guide
 description: Assistance for project maintainers, including the release schedule, versioning scheme, and instructions on how to build, test, and publish.
 keywords:
   - xpack
   - clang
-  - releases
   - build
+  - releases
   - publish
   - npmjs
 
 date: 2024-07-21 20:11:00 +0300
 
 ---
 
+
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -59,7 +61,8 @@ The Windows binaries are
 compiled on x64 GNU/Linux, using [mingw-w64](https://mingw-w64.org).
 
 For details on installing the prerequisites, please read the
-[XBB prerequisites page](https://xpack.github.io/xbb/prerequisites/).
+[Build Prerequisites](https://xpack-dev-tools.github.io/docs/developer/install/prerequisites/)
+page.
 
 ## Get project sources
 
@@ -952,3 +955,5 @@ The results are available from the
 Credit to [Shields IO](https://shields.io) for the badges and to
 [Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats)
 for the individual file counters.
+
+
diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx
@@ -17,6 +17,8 @@ date: 2024-07-21 18:56:00 +0300
 
 ---
 
+
+
 import customField from '@site/src/libs/customField';
 
 import Versioning from './_versioning.mdx';
@@ -38,3 +40,5 @@ to use the **xPack LLVM clang** binaries in their workflows.
 <More/>
 
 <UseInTesting/>
+
+
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -286,8 +286,9 @@ const config: Config = {
   ],
   // https://docusaurus.io/docs/seo
   themeConfig: {
-    // Replace with your project's social card
-    // image: 'img/docusaurus-social-card.jpg',
+    // The project's social card, og:image, twitter:image, 1200x630
+    image: 'img/sunrise-og-image.jpg',
+
     metadata: [
       {
         name: 'keywords',
@@ -326,9 +327,21 @@ const config: Config = {
               to: '/docs/install'
             },
             {
-              label: 'User Information',
+              label: 'User\'s Guide',
               to: '/docs/user'
             },
+            {
+              label: 'Contributor\'s Guide',
+              to: '/docs/developer'
+            },
+            {
+              label: 'Maintainer\'s Guide',
+              to: '/docs/maintainer'
+            },
+            {
+              label: 'FAQ',
+              to: '/docs/faq'
+            },
             {
               label: 'Help Centre',
               to: '/docs/support'

diff --git a/website/sidebars.ts b/website/sidebars.ts
@@ -34,43 +34,43 @@ const sidebars: SidebarsConfig = {
     {
       type: 'doc',
       id: 'user/index',
-      label: 'User Information'
+      label: 'User\'s Guide'
     },
     {
       type: 'doc',
-      id: 'faq/index',
-      label: 'FAQ'
+      id: 'developer/index',
+      label: 'Contributor\'s Guide'
     },
     {
       type: 'doc',
-      id: 'support/index',
-      label: 'Help Centre'
+      id: 'maintainer/index',
+      label: 'Maintainer\'s Guide'
     },
     {
       type: 'doc',
-      id: 'releases/index',
-      label: 'Releases'
+      id: 'tests/index',
+      label: 'Tests results'
     },
     {
       type: 'doc',
-      id: 'about/index',
-      label: 'About'
+      id: 'faq/index',
+      label: 'FAQ'
     },
     {
       type: 'doc',
-      id: 'developer/index',
-      label: 'Developer Information'
+      id: 'support/index',
+      label: 'Help Centre'
     },
     {
       type: 'doc',
-      id: 'maintainer/index',
-      label: 'Maintainer Information'
+      id: 'releases/index',
+      label: 'Releases'
     },
     {
       type: 'doc',
-      id: 'tests/index',
-      label: 'Tests results'
-    },
+      id: 'about/index',
+      label: 'About'
+    }
   ],
   testsSidebar: [{type: 'autogenerated', dirName: 'tests'}],
 };

diff --git a/website/src/css/custom.css b/website/src/css/custom.css
@@ -118,4 +118,8 @@ img.mac-stadium-img {
   width: 200px;
 }
 
+code {
+  vertical-align: baseline;
+}
+
 /* ------------------------------------------------------------------------- */
diff --git a/website/static/img/sunrise-og-image.jpg b/website/static/img/sunrise-og-image.jpg
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,8 @@ date: 2024-07-21 18:56:00 +0300 @@
     ---
     import customField from '@site/src/libs/customField';
     import Versioning from './_versioning.mdx';
@@ Expand All / @@ -38,3 +40,5 @@ to use the **xPack LLVM clang** binaries in their workflows. @@
     <More/>
     <UseInTesting/>