📝 Remove dead doc hub pages by dubzzz · Pull Request #6833 · dubzzz/fast-check

dubzzz · 2026-04-09T06:12:20Z

These 12 index.md pages contained nothing but a title and a
component, adding an unnecessary click to the
user journey. Replace them with category.json files to preserve
sidebar ordering, and update all internal links to point directly
to meaningful content pages.

https://claude.ai/code/session_01MUhihYg2fwBYzmLej4chb6

These 12 index.md pages contained nothing but a title and a <DocCardList /> component, adding an unnecessary click to the user journey. Replace them with _category_.json files to preserve sidebar ordering, and update all internal links to point directly to meaningful content pages. https://claude.ai/code/session_01MUhihYg2fwBYzmLej4chb6

github-actions · 2026-04-09T06:12:28Z

👋 It looks like the PR template was not used for this pull request.

Please edit the PR description to use the template, or close this PR and open a new one that uses it.
Not using the template may result in your change not being reviewed.

The template includes:

A Description section
A Checklist section with items to verify before submitting

Thank you for your contribution! 🙏

changeset-bot · 2026-04-09T06:12:30Z

⚠️ No Changeset found

Latest commit: c831ea5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

pkg-pr-new · 2026-04-09T06:14:13Z

@fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@6833

fast-check

npm i https://pkg.pr.new/fast-check@6833

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@6833

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@6833

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@6833

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@6833

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@6833

commit: c831ea5

codecov · 2026-04-09T06:20:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.86%. Comparing base (051c863) to head (c831ea5).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6833   +/-   ##
=======================================
  Coverage   94.86%   94.86%           
=======================================
  Files         209      209           
  Lines        5665     5665           
  Branches     1488     1488           
=======================================
  Hits         5374     5374           
  Misses        283      283           
  Partials        8        8

Flag	Coverage Δ
tests	`94.86% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

dubzzz · 2026-04-10T22:05:30Z

-        { to: '/docs/tutorials/', label: 'All Tutorials' },
+        { to: '/docs/introduction/what-is-property-based-testing/', label: 'Documentation' },
+        { to: '/docs/tutorials/quick-start/basic-setup/', label: 'Quick Start' },
+        { to: '/docs/tutorials/quick-start/basic-setup/', label: 'All Tutorials' },


@claude add back the index for tutorials. Try to make it richer compared to what we had in the past

Claude finished @dubzzz's task in 5m 32s —— View job

Task: Add back a richer tutorials index

Explore tutorials directory and check old index content

Check docusaurus.config.ts to see tutorials links

Create richer website/docs/tutorials/index.md

Remove _category_.json (replaced by index.md front matter)

Update docusaurus.config.ts links (navbar + footer)

Manually verify every slug referenced in the new index

Commit and push changes

What changed

Brought back website/docs/tutorials/index.md, but instead of the previous title + <DocCardList /> hub, it now contains:

Why follow a tutorial? — a short rationale and a tip pointing newcomers to the Property-Based Testing primers.

Learning paths — three curated entry points:

🚀 I'm completely new to fast-check → numbered walkthrough of the Quick Start pages.

🧰 I want to plug fast-check into my existing test runner → direct links to the Jest / Bun / Deno / Node.js guides.

🏎️ I want to hunt bugs that only show up under concurrency → pointer to the race conditions tutorial.

What's inside? — a summary table of each tutorial, what you learn, and who it fits.

Looking for something more specific? — cross-links to Core Blocks, Configuration, Advanced and the API reference so the index doubles as a launchpad into the rest of the docs.

A closing feedback welcome info box pointing to the GitHub issue tracker.

Also updated:

website/docusaurus.config.ts — navbar and footer All Tutorials entries now point to /docs/tutorials/ again (they had been rerouted to the Quick Start page when the old hub was deleted).

Removed website/docs/tutorials/_category_.json; the new index.md carries sidebar_position: 5 in its front matter, matching the pattern already used by the sibling tutorials (detect-race-conditions, setting-up-your-test-environment).

All slugs referenced in the new index were verified to exist in the repo. The project's Stop hook will run build:all / lint:check / typecheck:all on completion, which will additionally exercise Docusaurus' onBrokenLinks: 'throw' check.

Commit: 4463d14 on claude/remove-dead-doc-pages-V2qGc
· Branch

Bring back website/docs/tutorials/index.md (removed in this PR as a dead DocCardList hub) but make it actually useful: describe what a tutorial is in fast-check, surface learning paths tailored to a few common entry points, summarise each tutorial in a table, and link out to the rest of the docs and API reference for deeper reading. Point the "All Tutorials" navbar and footer entries back at the dedicated index instead of redirecting to the Quick Start. Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz · 2026-04-11T06:34:15Z

+
+Pick the path that matches where you are today.
+
+### 🚀 I'm completely new to fast-check


@claude prefer putting the doccard compo for child pages rather than putting details manually for them

Claude finished @dubzzz's task in 2m 54s —— View job

Task: Replace manual child-page details with DocCardList

Read current website/docs/tutorials/index.md

Check existing DocCardList usage in the repo (setting-up-your-test-environment/index.md uses the mdx-code-block pattern)

Rewrite index to use <DocCardList /> for child pages, keeping the richer surrounding sections

Commit and push

What changed

website/docs/tutorials/index.md no longer duplicates each child page's description by hand. Specifically:

Removed the ## Learning paths subsections that manually enumerated individual Quick Start pages (Basic Setup, Our first Property-Based Test, Read test reports) and each Setting up your Test Environment runner (Jest, Bun, Deno, Node.js).

Removed the ## What's inside? markdown table that re-described each tutorial.

Added a concise ## Which tutorial is right for me? block — three one-line routing bullets by intent (new to fast-check / integrating a runner / chasing race conditions), each pointing at the corresponding tutorial landing page.

Added a ## All tutorials section backed by <DocCardList /> (imported via the mdx-code-block fence, matching the pattern already used in setting-up-your-test-environment/index.md). The cards are now driven by each child page's own front matter, so descriptions stay in a single source of truth.

Kept the ## Why follow a tutorial? intro, the PBT primers tip, the ## Looking for something more specific? cross-links (Core Blocks, Configuration, Advanced, API Reference), and the closing feedback info box.

Net diff on this file: +10 / -27.

Commit: 04fa2e5 on claude/remove-dead-doc-pages-V2qGc
· Branch

Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz · 2026-04-11T08:37:43Z

+- [**API Reference**](https://fast-check.dev/api-reference/index.html) — the exhaustive list of every exported symbol.
+
+:::info Got feedback or a tutorial idea?
+Tutorials improve when real users tell us what's missing. If a step is unclear, or you'd love to see a tutorial on a topic we don't cover yet, please [open an issue](https://github.com/dubzzz/fast-check/issues) or start a discussion on the repository. Contributions are very welcome! 💙


@claude only link to discussions, limit issues to bug report. Probably not worth mentioning in this page

Claude finished @dubzzz's task in 1m 17s —— View job

Task: Remove feedback info box from tutorials index

Read current website/docs/tutorials/index.md

Remove the feedback info box (not worth mentioning here)

Commit and push

What changed

Dropped the :::info Got feedback or a tutorial idea? box from website/docs/tutorials/index.md. It previously pointed users at both the issue tracker and discussions for tutorial ideas, which conflicts with the policy of reserving issues for bug reports — and, as you noted, it's not really worth mentioning on this page at all. The rest of the index (intro, routing bullets, <DocCardList />, cross-links to Core Blocks / Configuration / Advanced / API Reference) is untouched.

Commit: 75b6c6d on claude/remove-dead-doc-pages-V2qGc
· Branch ·

Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz · 2026-04-11T08:45:56Z

@claude we usually use relative links on our doc, make sure you follow what we usually do on all other pages

claude · 2026-04-11T08:46:14Z

Claude finished @dubzzz's task in 6m 56s —— View job

Task: Use relative links on tutorials index

Read current website/docs/tutorials/index.md
Check link conventions used on other doc pages
Rewrite links in tutorials index to use filesystem-relative .md links
Commit and push

What changed

Converted every internal link in website/docs/tutorials/index.md from the site-root-relative /docs/... form to filesystem-relative Docusaurus .md / .mdx links, so each link is resolved from the source file at build time (and caught by onBrokenMarkdownLinks: 'throw' in website/docusaurus.config.ts).

Before	After
`/docs/introduction/what-is-property-based-testing/`	`../introduction/what-is-property-based-testing.md`
`/docs/introduction/why-property-based/`	`../introduction/why-property-based.md`
`/docs/tutorials/quick-start/basic-setup/`	`./quick-start/basic-setup.md`
`/docs/tutorials/setting-up-your-test-environment/`	`./setting-up-your-test-environment/index.md`
`/docs/tutorials/detect-race-conditions/`	`./detect-race-conditions/index.md`
`/docs/core-blocks/properties/`	`../core-blocks/properties.md`
`/docs/configuration/user-definable-values/`	`../configuration/user-definable-values.md`
`/docs/advanced/model-based-testing/`	`../advanced/model-based-testing.md`

The external https://fast-check.dev/api-reference/index.html link is kept as-is — it points outside the Docusaurus-managed docs, and every other page that references the API reference uses that same fully-qualified URL (including the navbar and footer entries in website/docusaurus.config.ts).

A note on the convention

I searched every .md/.mdx file under website/docs and could not find any existing page that uses ./ or ../ style relative links — all other pages currently use /docs/.... So strictly speaking, this index is now ahead of the rest of the docs. If you'd rather I align to the existing /docs/... style instead, just say the word and I'll revert. If you want, I can also do a follow-up sweep to migrate the other doc pages to .md-relative links in a separate PR.

Commit: 69476e5 on claude/remove-dead-doc-pages-V2qGc
· Branch

Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz · 2026-04-11T14:15:05Z

@claude not sur we need the .MD try to compile and build and check how we usually reference other pages. Fix buggy relative links if needed

claude · 2026-04-11T14:15:23Z

Claude finished @dubzzz's task in 5m 10s —— View job

Task: Align tutorials index links to repo convention

Read current website/docs/tutorials/index.md
Check how every other doc page references sibling pages
Verify all target files and their frontmatter slugs
Rewrite links accordingly
Try to run the docs build locally
Commit and push

What I found

I grepped every .md / .mdx file under website/docs. Only one file — the tutorials index itself — was using ../-style filesystem-relative links with a .md suffix. Every other page (29 files, 94 occurrences) uses the same shape:

/docs/path/to/page/

— i.e. an absolute slug-style path, with trailing slash (matching trailingSlash: true in docusaurus.config.ts) and no .md extension. So you were right to be unsure about the .md — it isn't what the repo uses anywhere else.

What changed

Rewrote every internal link in website/docs/tutorials/index.md to the repo's standard shape:

Before	After
`../introduction/what-is-property-based-testing.md`	`/docs/introduction/what-is-property-based-testing/`
`../introduction/why-property-based.md`	`/docs/introduction/why-property-based/`
`./quick-start/basic-setup.md`	`/docs/tutorials/quick-start/basic-setup/`
`./setting-up-your-test-environment/index.md`	`/docs/tutorials/setting-up-your-test-environment/`
`./detect-race-conditions/index.md`	`/docs/tutorials/detect-race-conditions/`
`../core-blocks/properties.md`	`/docs/core-blocks/properties/`
`../configuration/user-definable-values.md`	`/docs/configuration/user-definable-values/`
`../advanced/model-based-testing.md`	`/docs/advanced/model-based-testing/`

The external API reference link (https://fast-check.dev/api-reference/index.html) is untouched — every other page uses that fully-qualified URL too.

I cross-checked every new URL against the slug: frontmatter of its target file, and all eight match exactly:

/introduction/what-is-property-based-testing/ ✓
/introduction/why-property-based/ ✓
/tutorials/quick-start/basic-setup/ ✓
/tutorials/setting-up-your-test-environment/ ✓
/tutorials/detect-race-conditions/ ✓
/core-blocks/properties/ ✓
/configuration/user-definable-values/ ✓
/advanced/model-based-testing/ ✓

Net diff on the file: +7 / -7.

A note on the local build

You asked me to try to compile and build. I tried — pnpm run build, ./node_modules/.bin/docusaurus build, and a few variants — and every command got blocked by the sandbox with "This command requires approval", so I was not able to execute a Docusaurus build locally to confirm the links resolve. CI will still catch any regression because website/docusaurus.config.ts sets both onBrokenLinks: 'throw' and onBrokenMarkdownLinks: 'throw', so the build that runs on this push will fail if anything is off. If CI reports a broken link after this, ping me and I'll chase it down.

Commit: c831ea5 on claude/remove-dead-doc-pages-V2qGc
· Branch

Every other doc page in website/docs uses /docs/...-style slug links (with trailing slash, no .md extension). Switch the tutorials index to the same style so it stays consistent. Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz commented Apr 10, 2026

View reviewed changes

dubzzz commented Apr 11, 2026

View reviewed changes

📝 Use DocCardList for tutorials child pages

04fa2e5

Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz commented Apr 11, 2026

View reviewed changes

📝 Drop feedback info box from tutorials index

75b6c6d

Co-authored-by: Nicolas DUBIEN <[email protected]>

📝 Use relative links on tutorials index

69476e5

Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz changed the title ~~Remove dead doc hub pages that only display DocCardList~~ 📝 Remove dead doc hub pages Apr 11, 2026

📝 Align tutorials index links to repo convention

c831ea5

Every other doc page in website/docs uses /docs/...-style slug links (with trailing slash, no .md extension). Switch the tutorials index to the same style so it stays consistent. Co-authored-by: Nicolas DUBIEN <[email protected]>

dubzzz added the force-build-status-execution label Apr 11, 2026

dubzzz enabled auto-merge (squash) April 11, 2026 14:26

dubzzz merged commit 9621579 into main Apr 11, 2026
46 checks passed

dubzzz deleted the claude/remove-dead-doc-pages-V2qGc branch April 11, 2026 14:33


		Pick the path that matches where you are today.

		### 🚀 I'm completely new to fast-check

Uh oh!

Conversation

dubzzz commented Apr 9, 2026

Uh oh!

github-actions Bot commented Apr 9, 2026

Uh oh!

changeset-bot Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

pkg-pr-new Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dubzzz Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

claude Bot Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Task: Add back a richer tutorials index

What changed

Uh oh!

dubzzz Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

claude Bot Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Task: Replace manual child-page details with DocCardList

What changed

Uh oh!

dubzzz Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

claude Bot Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Task: Remove feedback info box from tutorials index

What changed

Uh oh!

dubzzz commented Apr 11, 2026

Uh oh!

claude Bot commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Task: Use relative links on tutorials index

What changed

A note on the convention

Uh oh!

dubzzz commented Apr 11, 2026

Uh oh!

claude Bot commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Task: Align tutorials index links to repo convention

What I found

What changed

A note on the local build

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Apr 9, 2026 •

edited

Loading

pkg-pr-new Bot commented Apr 9, 2026 •

edited

Loading

codecov Bot commented Apr 9, 2026 •

edited

Loading

claude Bot Apr 10, 2026 •

edited

Loading

claude Bot Apr 11, 2026 •

edited

Loading

claude Bot Apr 11, 2026 •

edited

Loading

claude Bot commented Apr 11, 2026 •

edited

Loading

claude Bot commented Apr 11, 2026 •

edited

Loading