refactor(cheatcodes): improve overview page and remove category index pages

- Remove cheatcode category index pages (environment, assertions, etc.)
- Add redirects for removed pages to overview
- Update sidebar to remove links from category headers
- Replace overview page content with Cards component
- Add search hint tip
- Remove Vm.sol generation (no longer embedded, now links to GitHub)
- Streamline Forge Std and Contributing sections

Author: onbjerg

scripts/gen_output.sh

@@ -7,8 +7,6 @@ source "$SCRIPTS/gen_output/cast.sh"
 source "$SCRIPTS/gen_output/chisel.sh"
 source "$SCRIPTS/gen_output/forge.sh"
 source "$SCRIPTS/gen_output/help.sh"
-source "$SCRIPTS/gen_output/vm.sh"
-
 need_cmd git
 need_cmd mktemp
 need_cmd sed
@@ -22,4 +20,3 @@ gen_help
 gen_cast
 gen_chisel
 gen_forge
-gen_vm

scripts/gen_output/vm.sh

@@ -4,7 +4,6 @@ export const cmdReference: SidebarItem[] = [
       { text: 'Overview', link: '/reference/cheatcodes/overview'},
       {
         text: 'Environment',
-        link: '/reference/cheatcodes/environment',
         collapsed: true,
         items: [
           { text: 'warp', link: '/reference/cheatcodes/warp' },
@@ -51,7 +50,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'Assertions',
-        link: '/reference/cheatcodes/assertions',
         collapsed: true,
         items: [
           { text: 'expectRevert', link: '/reference/cheatcodes/expect-revert' },
@@ -61,7 +59,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'Fuzzer',
-        link: '/reference/cheatcodes/fuzzer',
         collapsed: true,
         items: [
           { text: 'assume', link: '/reference/cheatcodes/assume' },
@@ -70,7 +67,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'Forking',
-        link: '/reference/cheatcodes/forking',
         collapsed: true,
         items: [
           { text: 'createFork', link: '/reference/cheatcodes/create-fork' },
@@ -87,7 +83,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'External',
-        link: '/reference/cheatcodes/external',
         collapsed: true,
         items: [
           { text: 'ffi', link: '/reference/cheatcodes/ffi' },
@@ -120,7 +115,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'Signing',
-        link: '/reference/cheatcodes/signing',
         collapsed: true,
         items: [
           { text: 'sign', link: '/reference/cheatcodes/sign' },
@@ -129,7 +123,6 @@ export const cmdReference: SidebarItem[] = [
       },
       {
         text: 'Utilities',
-        link: '/reference/cheatcodes/utilities',
         collapsed: true,
         items: [
           { text: 'addr', link: '/reference/cheatcodes/addr' },

sidebar/cmd-reference.ts

@@ -158,7 +158,6 @@ type Page =
 | { path: '/reference/cheatcodes/active-fork'; render: 'static' }
 | { path: '/reference/cheatcodes/addr'; render: 'static' }
 | { path: '/reference/cheatcodes/allow-cheatcodes'; render: 'static' }
-| { path: '/reference/cheatcodes/assertions'; render: 'static' }
 | { path: '/reference/cheatcodes/assume-no-revert'; render: 'static' }
 | { path: '/reference/cheatcodes/assume'; render: 'static' }
 | { path: '/reference/cheatcodes/breakpoint'; render: 'static' }
@@ -181,17 +180,13 @@ type Page =
 | { path: '/reference/cheatcodes/env-or'; render: 'static' }
 | { path: '/reference/cheatcodes/env-string'; render: 'static' }
 | { path: '/reference/cheatcodes/env-uint'; render: 'static' }
-| { path: '/reference/cheatcodes/environment'; render: 'static' }
 | { path: '/reference/cheatcodes/etch'; render: 'static' }
 | { path: '/reference/cheatcodes/expect-call'; render: 'static' }
 | { path: '/reference/cheatcodes/expect-emit'; render: 'static' }
 | { path: '/reference/cheatcodes/expect-revert'; render: 'static' }
-| { path: '/reference/cheatcodes/external'; render: 'static' }
 | { path: '/reference/cheatcodes/fee'; render: 'static' }
 | { path: '/reference/cheatcodes/ffi'; render: 'static' }
-| { path: '/reference/cheatcodes/forking'; render: 'static' }
 | { path: '/reference/cheatcodes/fs'; render: 'static' }
-| { path: '/reference/cheatcodes/fuzzer'; render: 'static' }
 | { path: '/reference/cheatcodes/gas-snapshots'; render: 'static' }
 | { path: '/reference/cheatcodes/get-block-number'; render: 'static' }
 | { path: '/reference/cheatcodes/get-block-timestamp'; render: 'static' }
@@ -245,7 +240,6 @@ type Page =
 | { path: '/reference/cheatcodes/set-nonce'; render: 'static' }
 | { path: '/reference/cheatcodes/sign-delegation'; render: 'static' }
 | { path: '/reference/cheatcodes/sign'; render: 'static' }
-| { path: '/reference/cheatcodes/signing'; render: 'static' }
 | { path: '/reference/cheatcodes/skip'; render: 'static' }
 | { path: '/reference/cheatcodes/sleep'; render: 'static' }
 | { path: '/reference/cheatcodes/start-broadcast'; render: 'static' }
@@ -260,7 +254,6 @@ type Page =
 | { path: '/reference/cheatcodes/transact'; render: 'static' }
 | { path: '/reference/cheatcodes/tx-gas-price'; render: 'static' }
 | { path: '/reference/cheatcodes/unix-time'; render: 'static' }
-| { path: '/reference/cheatcodes/utilities'; render: 'static' }
 | { path: '/reference/cheatcodes/warp'; render: 'static' }
 | { path: '/reference/cheatcodes/write-json'; render: 'static' }
 | { path: '/reference/cheatcodes/write-toml'; render: 'static' }

src/pages.gen.ts

@@ -1,9 +1,15 @@
+import { Cards, Card } from 'vocs'
+
 ## Cheatcodes Reference
 
 Cheatcodes give you powerful assertions, the ability to alter the state of the EVM, mock data, and more.
 
 Cheatcodes are made available through use of the cheatcode address (`0x7109709ECfa91a80626fF3989D68f67F5b1DD12D`).
 
+:::tip[Finding Cheatcodes]
+Use the sidebar to browse cheatcodes by category, or press `Ctrl+K` / `Cmd+K` to search for a specific cheatcode.
+:::
+
 :::note
 If you encounter errors for this address when using fuzzed addresses in your tests, you may wish to
 exclude it from your fuzz tests by using the following line:
@@ -16,35 +22,69 @@ exclude it from your fuzz tests by using the following line:
 
 You can also access cheatcodes easily via `vm` available in Forge Standard Library's [`Test`](/reference/forge-std/overview) contract.
 
-### Forge Standard Library Cheatcodes
-
-Forge Std implements wrappers around cheatcodes, which combine multiple standard cheatcodes to improve development experience. These are not technically cheatcodes, but rather compositions of Forge's cheatcodes.
-
-You can view the list of Forge Standard Library's cheatcode wrappers [in the references section](/reference/forge-std/std-cheats.mdx). You can reference the [Forge Std source code](https://github.com/foundry-rs/forge-std/blob/master/src/Test.sol) to learn more about how the wrappers work under the hood.
-
-### Cheatcode Types
-
-Below are some subsections for the different Forge cheatcodes.
-
-- [Environment](/reference/cheatcodes/environment.mdx): Cheatcodes that alter the state of the EVM.
-- [Assertions](/reference/cheatcodes/assertions.mdx): Cheatcodes that are powerful assertions
-- [Fuzzer](/reference/cheatcodes/fuzzer.mdx): Cheatcodes that configure the fuzzer
-- [External](/reference/cheatcodes/external.mdx): Cheatcodes that interact with external state (files, commands, ...)
-- [Signing](/reference/cheatcodes/signing.mdx): Cheatcodes for signing
-- [Utilities](/reference/cheatcodes/utilities.mdx): Smaller utility cheatcodes
-- [Forking](/reference/cheatcodes/forking.mdx): Forking mode cheatcodes
-- [State snapshots](/reference/cheatcodes/state-snapshots.mdx): State snapshot cheatcodes
-- [RPC](/reference/cheatcodes/rpc.mdx): RPC related cheatcodes
-- [File](/reference/cheatcodes/fs.mdx): Cheatcodes for working with files
-
-### Add a new cheatcode
-
-If you need a new feature, consider [contributing to the Foundry's codebase](https://github.com/foundry-rs/foundry) to add the cheatcode.
+### Cheatcode Categories
+
+<Cards>
+  <Card
+    title="Environment"
+    description="Manipulate the EVM state: block timestamp, number, msg.sender, storage, balances, and more."
+    to="/reference/cheatcodes/warp"
+  />
+  <Card
+    title="Assertions"
+    description="Expect reverts, events, and calls in your tests."
+    to="/reference/cheatcodes/expect-revert"
+  />
+  <Card
+    title="Fuzzer"
+    description="Control fuzzer behavior with assumptions and constraints."
+    to="/reference/cheatcodes/assume"
+  />
+  <Card
+    title="Forking"
+    description="Create and manage forks of live networks."
+    to="/reference/cheatcodes/create-fork"
+  />
+  <Card
+    title="External"
+    description="Interact with the outside world: run commands, read environment variables, parse JSON/TOML."
+    to="/reference/cheatcodes/ffi"
+  />
+  <Card
+    title="Signing"
+    description="Sign messages and EIP-7702 delegations."
+    to="/reference/cheatcodes/sign"
+  />
+  <Card
+    title="Utilities"
+    description="Helper functions for addresses, labels, parsing, and wallets."
+    to="/reference/cheatcodes/addr"
+  />
+  <Card
+    title="Files"
+    description="Read and write files from your tests and scripts."
+    to="/reference/cheatcodes/fs"
+  />
+  <Card
+    title="RPC"
+    description="Register and interact with RPC endpoints."
+    to="/reference/cheatcodes/rpc"
+  />
+  <Card
+    title="State Snapshots"
+    description="Snapshot and restore EVM state."
+    to="/reference/cheatcodes/state-snapshots"
+  />
+</Cards>
+
+### Forge Standard Library
+
+Forge Std implements wrappers around cheatcodes, which combine multiple standard cheatcodes to improve development experience. See [Std Cheats](/reference/forge-std/std-cheats) for more details.
+
+### Contributing
+
+If you need a new cheatcode, consider [contributing to the Foundry codebase](https://github.com/foundry-rs/foundry).
 
 ### Cheatcodes Interface
 
-This is a Solidity interface for all of the cheatcodes present in Forge.
-
-```solidity
-// [!include ~/snippets/output/vm/Vm.sol]
-```
+The complete Solidity interface for all cheatcodes is available in the [forge-std repository](https://github.com/foundry-rs/forge-std/blob/master/src/Vm.sol).