Updated docs

.github/workflows/ci-docs.yml

@@ -0,0 +1,42 @@
+name: CI-docs-website
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - '**'
+    paths:
+      - '*.lock'
+      - 'docs/**'
+
+permissions:
+  contents: read
+
+jobs:
+  generate-docs-website:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+    env:
+      NEXTJS_IGNORE_ESLINT: true
+      NEXTJS_IGNORE_TYPECHECK: true
+      NEXT_DISABLE_SOURCEMAPS: true
+      NEXT_TELEMETRY_DISABLED: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: ⚙️ Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: 📥 Monorepo install
+        uses: ./.github/actions/yarn-nm-install
+
+      - name: 🏗 Build docs
+        run: yarn workspace httpx-docs run build

.github/workflows/ci-packages.yml

@@ -10,12 +10,13 @@ on:
       - '**'
     paths-ignore:
       - 'examples/**'
+      - 'docs/**'
 
 permissions:
   contents: read
 
 jobs:
-  test:
+  test-packages:
     runs-on: ubuntu-latest
     strategy:
       matrix:

.gitignore

@@ -16,12 +16,12 @@ nx-cloud.env
 
 # dependencies
 **/node_modules
-.yarn/*
-!.yarn/patches
-!.yarn/releases
-!.yarn/plugins
-!.yarn/sdks
-!.yarn/versions
+**/.yarn/*
+!**/.yarn/patches
+!**/.yarn/releases
+!**/.yarn/plugins
+!**/.yarn/sdks
+!**/.yarn/versions
 .pnp.*
 
 # testing

.prettierignore

@@ -4,4 +4,4 @@
 **/build/**
 **/tmp/**
 **/generated/**
-
+**/out/**

CONTRIBUTING.md

@@ -42,7 +42,7 @@ If applicable:
 | `yarn g:clean`               | Clean builds in all workspaces                                                                                                        |
 | `yarn g:check-dist`          | Ensure build dist files passes es2017 (run `g:build` first).                                                                          |
 | `yarn g:check-size`          | Ensure build files are within size limit (run `g:build` first).                                                                       |
-| `yarn g:build-doc`           | Build documentation (generally api doc)                                                                                               |
+| `yarn g:build-api-doc`       | Build documentation (generally api doc)                                                                                               |
 | `yarn clean:global-cache`    | Clean tooling caches (eslint, jest...)                                                                                                |
 | `yarn deps:check --dep dev`  | Will print what packages can be upgraded globally (see also [.ncurc.yml](https://github.com/belgattitude/httpx/blob/main/.ncurc.yml)) |
 | `yarn deps:update --dep dev` | Apply possible updates (run `yarn install && yarn dedupe` after)                                                                      |

README.md

@@ -1,11 +1,10 @@
-# Collection of "do one thing" typescript libraries.
+## "do one thing" collection.
 
-## [@httpx/exception](https://github.com/belgattitude/httpx/tree/main/packages/exception#readme)
+### [@httpx/exception](https://github.com/belgattitude/httpx/tree/main/packages/exception#readme)
 
-HTTP response errors with default message, stacktrace, instanceof, error cause support.
-No deps, esm starts at 350b, tops at 1.4kb (esm). Includes convenience typeguards, optional
-error context and a built-in json (de-)serializer to allow usage across browser and
-node environments (SSR, RSC...) or for logging purpose.
+HTTP error responses with default message, instanceof, stack and error cause support.
+Lightweight, esm starts at 350b. Includes convenience typeguards, optional
+contextual info and a built-in serializer to cover cross-environments challenges (RSC, SSR...).
 
 [![npm](https://img.shields.io/npm/v/@httpx/exception?style=for-the-badge&label=Npm&labelColor=444&color=informational)](https://www.npmjs.com/package/@httpx/exception)
 [![changelog](https://img.shields.io/static/v1?label=&message=changelog&logo=github&style=for-the-badge&labelColor=444&color=informational)](https://github.com/belgattitude/httpx/blob/main/packages/exception/CHANGELOG.md)
@@ -14,7 +13,7 @@ node environments (SSR, RSC...) or for logging purpose.
 [![maintainability](https://img.shields.io/codeclimate/maintainability/belgattitude/httpx?label=Quality&logo=code-climate&style=for-the-badge&labelColor=444)](https://codeclimate.com/github/belgattitude/httpx)
 [![downloads](https://img.shields.io/npm/dm/@httpx/exception?style=for-the-badge&labelColor=444)](https://www.npmjs.com/package/@httpx/exception)
 
-## [@httpx/dsn-parser](https://github.com/belgattitude/httpx/tree/main/packages/dsn-parser#readme)
+### [@httpx/dsn-parser](https://github.com/belgattitude/httpx/tree/main/packages/dsn-parser#readme)
 
 DSN & JDBC string parser with query params support in a light and modern package.
 

docs/.eslintrc.cjs

@@ -0,0 +1,60 @@
+/**
+ * Specific eslint rules for this workspace, learn how to compose
+ * @link https://github.com/belgattitude/perso/tree/main/packages/eslint-config-bases
+ */
+
+// Workaround for https://github.com/eslint/eslint/issues/3458
+require('@belgattitude/eslint-config-bases/patch/modern-module-resolution');
+
+const {
+  getDefaultIgnorePatterns,
+} = require('@belgattitude/eslint-config-bases/helpers');
+
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: 'tsconfig.json',
+  },
+  ignorePatterns: [...getDefaultIgnorePatterns()],
+  extends: [
+    '@belgattitude/eslint-config-bases/typescript',
+    '@belgattitude/eslint-config-bases/sonar',
+    '@belgattitude/eslint-config-bases/regexp',
+    '@belgattitude/eslint-config-bases/jest',
+    '@belgattitude/eslint-config-bases/react',
+    '@belgattitude/eslint-config-bases/rtl',
+    '@belgattitude/eslint-config-bases/tailwind',
+    // Add specific rules for nextjs
+    'next/core-web-vitals',
+    // Apply prettier and disable incompatible rules
+    '@belgattitude/eslint-config-bases/prettier-plugin',
+  ],
+  rules: {
+    // optional overrides per project
+    '@typescript-eslint/require-await': 'off',
+  },
+  overrides: [
+    {
+      files: ['next.config.mjs', 'src/lib/env/*.mjs'],
+      rules: {
+        'import/order': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+      },
+    },
+    {
+      files: ['theme.config.tsx'],
+      rules: {
+        'react-hooks/rules-of-hooks': 'off',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
+      },
+    },
+    {
+      files: ['tailwind.config.ts'],
+      rules: {
+        '@typescript-eslint/naming-convention': 'off',
+      },
+    },
+  ],
+};

docs/.gitignore

@@ -0,0 +1 @@
+out