Skip to content

Fix documentation typos and broken links #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BenJenkyn wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix documentation typos and broken links #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fe8aa8
fixes typo
BenJenkyn May 5, 2026
ee6d4a0
fixes typo
BenJenkyn May 5, 2026
e009c87
fixes broken solid js link in readmes
BenJenkyn May 7, 2026
62a6983
fixes broken solid js link wherever else I could find it
BenJenkyn May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ You get:
- Minimal bundle size
- All the vite features

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Get started

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

These templates are meant to be used as is via the [degit](https://github.com/Rich-Harris/degit) utility.

Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-authjs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Everything you need to build an [AuthJS](https://authjs.dev/) authenticated Soli

This will start a production server on port `3000`.

### Enviroment Variables
### Environment Variables

- `DISCORD_ID`=
- `DISCORD_SECRET`=
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-mdx/src/routes/[...404].mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import { HttpStatusCode } from "@solidjs/start";

# Page Not Found

Visit [https://solidjs.com](https://solidjs.com) to learn how to build Solid apps.
Visit [https://www.solidjs.com/](https://www.solidjs.com/) to learn how to build Solid apps.
2 changes: 1 addition & 1 deletion solid-start-v1/with-mdx/src/routes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import Counter from "~/components/Counter";

<Counter />

Visit [https://solidjs.com](https://solidjs.com) to learn how to build Solid apps.
Visit [https://www.solidjs.com/](https://www.solidjs.com/) to learn how to build Solid apps.
2 changes: 1 addition & 1 deletion solid-start-v1/with-tailwindcss/src/routes/[...404].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default function NotFound() {
<h1 class="max-6-xs text-6xl text-sky-700 font-thin uppercase my-16">Not Found</h1>
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-tailwindcss/src/routes/about.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function About() {
<Counter />
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-tailwindcss/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function Home() {
<Counter />
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-unocss/src/routes/[...404].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default function NotFound() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-unocss/src/routes/about.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export default function About() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-unocss/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default function Home() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v1/with-vitest/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function Home() {
<Counter />
<p>
Visit{" "}
<a href="https://solidjs.com" target="_blank">
<a href="https://www.solidjs.com/" target="_blank">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-authjs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Everything you need to build an [AuthJS](https://authjs.dev/) authenticated Soli

This will start a production server on port `3000`.

### Enviroment Variables
### Environment Variables

- `DISCORD_ID`=
- `DISCORD_SECRET`=
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-mdx/src/routes/[...404].mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import { HttpStatusCode } from "@solidjs/start";

# Page Not Found

Visit [https://solidjs.com](https://solidjs.com) to learn how to build Solid apps.
Visit [https://www.solidjs.com/](https://www.solidjs.com/) to learn how to build Solid apps.
2 changes: 1 addition & 1 deletion solid-start-v2/with-mdx/src/routes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ import Counter from "~/components/Counter";

<Counter />

Visit [https://solidjs.com](https://solidjs.com) to learn how to build Solid apps.
Visit [https://www.solidjs.com/](https://www.solidjs.com/) to learn how to build Solid apps.
2 changes: 1 addition & 1 deletion solid-start-v2/with-tailwindcss/src/routes/[...404].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default function NotFound() {
<h1 class="max-6-xs text-6xl text-sky-700 font-thin uppercase my-16">Not Found</h1>
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-tailwindcss/src/routes/about.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function About() {
<Counter />
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-tailwindcss/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function Home() {
<Counter />
<p class="mt-8">
Visit{" "}
<a href="https://solidjs.com" target="_blank" class="text-sky-600 hover:underline">
<a href="https://www.solidjs.com/" target="_blank" class="text-sky-600 hover:underline">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-unocss/src/routes/[...404].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default function NotFound() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-unocss/src/routes/about.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export default function About() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-unocss/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default function Home() {
<p class="mt-8">
Visit{" "}
<a
href="https://solidjs.com"
href="https://www.solidjs.com/"
target="_blank"
class="text-sky-600 hover:underline"
>
Expand Down
2 changes: 1 addition & 1 deletion solid-start-v2/with-vitest/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default function Home() {
<Counter />
<p>
Visit{" "}
<a href="https://solidjs.com" target="_blank">
<a href="https://www.solidjs.com/" target="_blank">
solidjs.com
</a>{" "}
to learn how to build Solid apps.
Expand Down
4 changes: 2 additions & 2 deletions vanilla/bare/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-bootstrap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-sass/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-solid-router/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
Expand All @@ -15,7 +15,7 @@ It also showcase how the router and Suspense work together to parallelize data f

You can learn more about it on the [`@solidjs/router` repository](https://github.com/solidjs/solid-router)

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-tailwindcss/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-unocss/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down
4 changes: 2 additions & 2 deletions vanilla/with-vite-plugin-pages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
Expand All @@ -15,7 +15,7 @@ It also showcase how the router and Suspense work together to parallelize data f

You can learn more about it on the [`@solidjs/router` repository](https://github.com/solidjs/solid-router)

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
### Learn more on the [Solid Website](https://www.solidjs.com/) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

Expand Down