docs: improve documentation

wellwelwel · Jul 27, 2024 · c9f831d · c9f831d
1 parent 32af576
commit c9f831d
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/website/docs/documentation/poku/options/concurrency.mdx b/website/docs/documentation/poku/options/concurrency.mdx
@@ -4,9 +4,9 @@ sidebar_position: 8
 
 # `concurrency`
 
-When using `parallel` option, use `concurrency` to limit the number of tests running concurrently.<br />
-The default value is half of the available cores. When available, the `os.availableParallelism()` method is used. Otherwise Poku looks at the `os.cpus().length` or sets the value to `1`.<br />
-To allow unlimited parallelism set the value to `0`.
+When using `parallel` option, use `concurrency` to limit the number of tests running concurrently.
+
+The default value is half of the available cores or, when available, the `os.availableParallelism()` method is used. Otherwise **Poku** looks at the `os.cpus().length` or sets the value to `1`.
 
 ## CLI
 
@@ -22,3 +22,9 @@ await poku('./test', {
   concurrency: 4,
 });
 ```
+
+<hr />
+
+:::tip
+To allow unlimited parallelism set the value to `0`.
+:::
diff --git a/website/docs/index.mdx b/website/docs/index.mdx
@@ -19,7 +19,7 @@ import '@site/src/css/features.scss';
 
 [![NPM Downloads](https://img.shields.io/npm/v/poku.svg?label=&color=70a1ff&logo=npm&logoColor=white)](https://www.npmjs.com/package/poku)
 [![NPM Downloads](https://img.shields.io/npm/dt/poku.svg?label=&logo=npm&logoColor=white&color=45aaf2)](https://www.npmjs.com/package/poku)
-[![Coverage](https://img.shields.io/codecov/c/github/wellwelwel/poku?label=&logo=codecov&logoColor=white&color=98cc00)](https://app.codecov.io/github/wellwelwel/poku)<br />
+[![Coverage](https://img.shields.io/codecov/c/github/wellwelwel/poku?label=&logo=codecov&logoColor=white&color=98cc00)](https://github.com/wellwelwel/poku/tree/main/.nycrc)<br />
 [![GitHub Workflow Status (Linux)](https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci_coverage-linux.yml?event=push&label=&branch=main&logo=ubuntu&logoColor=8897a9&color=dfe4ea)](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-linux.yml?query=branch%3Amain)
 [![GitHub Workflow Status (OSX)](https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci_coverage-osx.yml?event=push&label=&branch=main&logo=apple&logoColor=8897a9&color=dfe4ea)](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-osx.yml?query=branch%3Amain)
 [![GitHub Workflow Status (Windows)](https://img.shields.io/github/actions/workflow/status/wellwelwel/poku/ci_coverage-windows.yml?event=push&label=&branch=main&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAxMjggMTI4IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjx0aXRsZT5XaW5kb3dzIDExPC90aXRsZT48cGF0aCBmaWxsPSIjODg5N2E5IiBkPSJNMTI2IDEuNjM3bC02NyA5LjgzNHY0OS44MzFsNjctLjUzNHpNMS42NDcgNjYuNzA5bC4wMDMgNDIuNDA0IDUwLjc5MSA2Ljk4My0uMDQtNDkuMDU3em01Ni44Mi42OGwuMDk0IDQ5LjQ2NSA2Ny4zNzYgOS41MDkuMDE2LTU4Ljg2M3pNMS42MSAxOS4yOTdsLjA0NyA0Mi4zODMgNTAuNzkxLS4yODktLjAyMy00OS4wMTZ6Ij48L3BhdGg+PC9zdmc+&color=dfe4ea)](https://github.com/wellwelwel/poku/actions/workflows/ci_coverage-windows.yml?query=branch%3Amain)

diff --git a/website/docs/tutorials/cross-platform.mdx b/website/docs/tutorials/cross-platform.mdx
@@ -34,6 +34,12 @@ npx poku
 
 - It tries to identify the platform or run it in **Node.js** by default.
 
+```sh
+npx poku --node
+```
+
+- It calls **Poku** through **Node.js**, but runs all the tests using **Node.js**.
+
 ```sh
 npx poku --bun
 ```
@@ -68,7 +74,7 @@ npx poku --node
 - It runs **Poku** through **Node.js** and ensures that all tests are run with **Node.js** (or **tsx** for **TypeScript** tests).
 
 ```sh
-bun poku --bun
+bunx poku --bun
 ```
 
 - It runs **Poku** through **Bun** and ensures that all tests are run with **Bun**.