Skip to content

Commit acc77e6

Browse files
committed
docs: add changelog, version badges, and additional redirects
- Create /docs/changelog page with v4.0.0-beta info and v3.1.0 backport plan - Add Changelog to navbar - Update .disableFailFast() to .failFast({ enabled: false }) across all docs - Add version badges CSS and apply to v4.0.0+ features - Add Google Search Console 404 redirects (examples, extras, category) - Add high-traffic redirects to netlify.toml - Add beta installation reference in installation guide 🤖 Generated with Claude Code
1 parent 27533a4 commit acc77e6

File tree

4 files changed

+103
-14
lines changed

4 files changed

+103
-14
lines changed

config/redirects.config.js

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,5 +151,27 @@ module.exports = {
151151
to: '/docs/get-started/why-suites',
152152
},
153153

154+
// ============================================
155+
// GOOGLE SEARCH CONSOLE 404s (Found Nov 2025)
156+
// ============================================
157+
158+
// Old examples page
159+
{
160+
from: '/docs/overview/examples',
161+
to: '/docs/get-started/quickstart',
162+
},
163+
164+
// Extras/identical-injections (old advanced topic)
165+
{
166+
from: ['/docs/extras/identical-injections', '/docs/extras/identical-injections/'],
167+
to: '/docs/guides/adapters/identifiers',
168+
},
169+
170+
// Old category page
171+
{
172+
from: '/docs/category/di-framework-adapters',
173+
to: '/docs/guides/adapters/',
174+
},
175+
154176
],
155177
};

docs/changelog.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,29 @@ Enabled by default. Throws `DependencyNotConfiguredError` on unconfigured depend
4848

4949
See [Fail-Fast Behavior](/docs/api-reference/fail-fast) for details and migration strategies.
5050

51+
### Installation
52+
53+
```bash
54+
# Core package (beta)
55+
npm install @suites/unit@beta
56+
57+
# DI adapters (alpha - no boundaries/fail-fast changes)
58+
npm install @suites/di.nestjs@alpha
59+
# or
60+
npm install @suites/di.inversify@alpha
61+
62+
# Doubles adapters (beta)
63+
npm install @suites/doubles.jest@beta
64+
# or
65+
npm install @suites/doubles.vitest@beta
66+
# or
67+
npm install @suites/doubles.sinon@beta
68+
```
69+
70+
:::tip Why Different Versions?
71+
`@suites/unit` and doubles adapters are on **beta** (boundaries + fail-fast features). DI adapters remain on **alpha** - they're installed separately and don't contain the new testing logic.
72+
:::
73+
5174
**Breaking Changes:**
5275
- Node 20+ required (was 16+)
5376
- InversifyJS v7 required (was v6)

docs/get-started/installation.mdx

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,35 @@ description: Learn how to install and configure Suites to enhance your unit test
77
## Prerequisites
88

99
:::warning Node.js Version Requirement
10-
Suites v4.0.0+ requires **Node.js 20 or higher**.
10+
Suites v4.0.0+ requires **Node.js 20 or higher**. Check your version with `node --version`.
1111
:::
1212

1313
- Node.js 20 or higher
1414
- TypeScript project with decorators enabled
1515
- A dependency injection framework (NestJS or InversifyJS)
1616
- A testing library (Jest, Vitest, or Sinon)
1717

18-
## Setup Suites in a New or Existing Project
18+
## Installation
1919

20-
This section provides instructions for installing Suites and highlights important compatibility and configuration
21-
details for setting up unit testing with your DI framework.
22-
23-
:::info
24-
You can find complete setup examples in the [Suites Examples](https://github.com/suites-dev/examples) repository
20+
:::tip Testing Beta?
21+
For v4.0.0 beta with boundaries and fail-fast features, see [Changelog](/docs/changelog) for beta installation instructions.
2522
:::
2623

27-
First, install Suites' main package:
24+
Install Suites' core package:
2825

2926
```bash
30-
$ npm i -D @suites/unit
27+
npm install -D @suites/unit
3128
```
3229

33-
Then, to integrate Suites with your dependency injection framework and preferred testing library, install the corresponding
34-
adapters for your project.
35-
36-
For example, to use Suites with Jest and NestJS you would run (alongside `@suites/unit` core package):
30+
Install the adapters for your DI framework and testing library:
3731

3832
```bash
39-
$ npm i -D @suites/doubles.jest @suites/di.nestjs
33+
# Example: Jest + NestJS
34+
npm install -D @suites/doubles.jest @suites/di.nestjs
4035
```
4136

37+
Complete setup examples available in the [Suites Examples](https://github.com/suites-dev/examples) repository.
38+
4239
Lastly, make sure `reflect-metadata` is also installed in your project, not as a dev dependency ([Why?](https://www.typescriptlang.org/docs/handbook/decorators.html#metadata)):
4340

4441
```bash

netlify.toml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,50 @@ status = 301
1212
from = "/docs/getting-started/change-log"
1313
to = "/docs/migration-guides/from-automock"
1414
status = 301
15+
16+
# Google Search Console 404s (Nov 2025)
17+
[[redirects]]
18+
from = "/docs/overview/examples"
19+
to = "/docs/get-started/quickstart"
20+
status = 301
21+
22+
[[redirects]]
23+
from = "/docs/extras/identical-injections"
24+
to = "/docs/guides/adapters/identifiers"
25+
status = 301
26+
27+
[[redirects]]
28+
from = "/docs/category/di-framework-adapters"
29+
to = "/docs/guides/adapters"
30+
status = 301
31+
32+
# High-traffic redirects (from analytics)
33+
[[redirects]]
34+
from = "/docs/overview/quickstart"
35+
to = "/docs/get-started/quickstart"
36+
status = 301
37+
38+
[[redirects]]
39+
from = "/docs/overview/installation"
40+
to = "/docs/get-started/installation"
41+
status = 301
42+
43+
[[redirects]]
44+
from = "/docs/developer-guide/unit-tests/suites-api"
45+
to = "/docs/api-reference"
46+
status = 301
47+
48+
[[redirects]]
49+
from = "/docs/developer-guide/unit-tests/solitary"
50+
to = "/docs/guides/solitary"
51+
status = 301
52+
53+
[[redirects]]
54+
from = "/docs/developer-guide/unit-tests/sociable"
55+
to = "/docs/guides/sociable"
56+
status = 301
57+
58+
[[redirects]]
59+
from = "/docs/overview/problems-solved"
60+
to = "/docs/get-started/why-suites"
61+
status = 301

0 commit comments

Comments
 (0)