update

Author: thomasbuilds

CONTRIBUTING.md

@@ -2,7 +2,9 @@
 
 - **Node.js**: Version 22 or higher
 - Use a Node.js version manager compatible with `.node-version` ([asdf-vm](https://asdf-vm.com) is a great option for macOS/Linux users)
-- Use pnpm packet manager
+- Use pnpm package manager
+
+## Setup
 
 ```bash
 # Clone the SolidStart repository
@@ -20,14 +22,45 @@ pnpm install
 ```
 
 ```bash
-# Build the SolidStart project
-pnpm build
+# Build dependencies
+pnpm run build:all
+```
+
+## Testing Changes
+
+1. Modify the codebase as needed.
+2. Run an example project to verify your changes work as expected:
+
+```bash
+# Run an example (e.g. hackernews)
+pnpm --filter example-hackernews run dev
+```
+
+3. Run tests
+
+```bash
+# Setup Playwright
+pnpm run install:playwright
 ```
 
-If you are using SolidStart within a monorepo that takes advantage of the `package.json` `"workspaces"` property (e.g. [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces)) with hoisted dependencies (the default for Yarn), you must include `@solidjs/start` within the optional `"nohoist"` (for Yarn v2 or higher, see further down for instructions) workspaces property.
+```bash
+# Run all tests
+pnpm run test:all
+```
+
+```bash
+# Show test report
+pnpm run show:test-report
+```
+
+## Monorepo Configuration
+
+If you are using SolidStart within a monorepo that takes advantage of the `package.json` `"workspaces"` property (e.g. [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces)) with hoisted dependencies (the default for Yarn), you must include `@solidjs/start` within the optional `"nohoist"` (for Yarn v1) or configure hoisting limits (for Yarn v2 or higher) to ensure dependencies are correctly placed.
 
 - _In the following, "workspace root" refers to the root of your repository, while "project root" refers to the root of a child package within your repository._
 
+### Yarn v1 (nohoist)
+
 For example, if specifying `"nohoist"` options from the workspace root (i.e., for all packages):
 
 ```jsonc
@@ -57,7 +90,7 @@ Regardless of where you specify the `nohoist` option, you also need to include `
 
 The reason why this is necessary is because `@solidjs/start` creates an `index.html` file within your project which expects to load a script located in `/node_modules/@solidjs/start/runtime/entry.jsx` (where `/` is the path of your project root). By default, if you hoist the `@solidjs/start` dependency into the workspace root, then that script will not be available within the package's `node_modules` folder.
 
-**Yarn v2 or Higher**
+### Yarn v2 or Higher
 
 The `nohoist` option is no longer available in Yarn v2+. In this case, we can use the `installConfig` property in the `package.json` (either workspace package or a specific project package) to make sure our dependencies are not hoisted:
 

README.md

@@ -1,11 +1,15 @@
 [![Banner](https://assets.solidjs.com/banner?project=Start&type=core)](https://github.com/solidjs)
 
+<div align="center">
+
 [![Version](https://img.shields.io/npm/v/@solidjs/start.svg?style=for-the-badge&color=blue&logo=npm)](https://npmjs.com/package/@solidjs/start)
 [![Downloads](https://img.shields.io/npm/dm/@solidjs/start.svg?style=for-the-badge&color=green&logo=npm)](https://npmjs.com/package/@solidjs/start)
 [![Stars](https://img.shields.io/github/stars/solidjs/solid-start?style=for-the-badge&color=yellow&logo=github)](https://github.com/solidjs/solid-start)
 [![Discord](https://img.shields.io/discord/722131463138705510?label=join&style=for-the-badge&color=5865F2&logo=discord)](https://discord.com/invite/solidjs)
 [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/solidjs?label=join&style=for-the-badge&color=FF4500&logo=reddit)](https://reddit.com/r/solidjs)
 
+</div>
+
 **SolidStart** brings fine-grained reactivity fullstack with full flexibility. Built with features like unified rendering and isomorphic code execution, SolidStart enables you to create highly performant and scalable web applications.
 
 Explore the official [documentation](https://docs.solidjs.com/solid-start) for detailed guides and examples.
@@ -15,7 +19,7 @@ Explore the official [documentation](https://docs.solidjs.com/solid-start) for d
 - **All Rendering Modes**:
   - Server-Side Rendering _(SSR)_ with sync, async, and stream [modes](https://docs.solidjs.com/solid-start/reference/server/create-handler)
   - Client-Side Rendering _(CSR)_
-  - Static Site Generation _(SSG)_
+  - Static Site Generation _(SSG)_ with route [pre-rendering](https://docs.solidjs.com/solid-start/building-your-application/route-prerendering)
 - **TypeScript**: Full integration for robust, type-safe development
 - **File-Based Routing**: Intuitive routing based on your project’s file structure
 - **API Routes**: Dedicated server-side endpoints for seamless API development