Merge pull request #426 from TypedDevs/docs/project-overview

Add project overview to website

Author: Chemaclass

CHANGELOG.md

@@ -8,6 +8,7 @@
 - Count data providers when counting total tests
 - Add benchmark feature
 - Support placeholder `::ignore::` in snapshots
+- Add project overview docs
 
 ## [0.20.0](https://github.com/TypedDevs/bashunit/compare/0.19.1...0.20.0) - 2025-06-01
 

docs/.vitepress/config.ts

@@ -90,6 +90,9 @@ export default defineConfig({
       }, {
         text: 'Examples',
         link: '/examples'
+      }, {
+        text: 'Project overview',
+        link: '/project-overview',
       }, {
         text: 'Support',
         link: '/support',

docs/project-overview.md

@@ -0,0 +1,49 @@
+# Project overview
+
+**bashunit** is a lightweight testing framework for Bash. It focuses on helping developers verify their shell scripts with minimal setup. The library bundles hundreds of assertions and helpers, including spies, mocks and data providers.
+
+This repository hosts the bashunit source code, its documentation and many automated tests. New contributors can use this overview to understand the basic layout and workflow when working on the project.
+
+## Repository layout
+
+- `src` – library functions used by `bashunit`.
+- `bin` – the executable entry points.
+- `adrs` – internal architecture decisions records.
+- `example` – example scripts and tests demonstrating usage.
+- `tests` – automated tests for bashunit itself.
+- `docs` – documentation built with [VitePress](https://vitepress.dev/).
+
+## Running tests
+
+The project uses bashunit to test itself. To execute the full suite, run:
+
+::: code-group
+```bash [Quick]
+./bashunit -s -p tests # Regular tests
+./bashunit -s -b tests # Benchmark tests
+```
+```bash [Complete]
+./bashunit --simple --parallel tests # Regular tests
+./bashunit --simple --bench    tests # Benchmark tests
+```
+:::
+
+
+> See more command line options: [here](/command-line)
+
+## Contributing
+
+Pull requests are welcome! Please read the [contribution guide](https://github.com/TypedDevs/bashunit/blob/main/.github/CONTRIBUTING.md) before sending patches. All contributions are covered by the MIT license.
+
+For documentation changes you can preview locally with:
+
+```bash
+npm ci
+npm run docs:dev
+```
+
+Before submitting your pull request ensure that `npm run docs:build` succeeds and that the test suite passes.
+
+## Further reading
+
+For a step‑by‑step introduction check the [quickstart](/quickstart). Detailed usage of individual features is explained throughout the docs site.