Skip to content

Commit 07736c3

Browse files
committed
Fix typo
1 parent 5ebc877 commit 07736c3

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

src/routes/solid-start/building-your-application/api-routes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ While Server Functions can be a good way to write server-side code for data need
66
Some reasons for wanting API Routes include:
77
- There are additional clients that want to share this logic.
88
- Exposing a GraphQL or tRPC endpoint.
9-
- Exposing a public facing REST API.
9+
- Exposing a public-facing REST API.
1010
- Writing webhooks or auth callback handlers for OAuth.
1111
- Having URLs not serving HTML, but other kinds of documents like PDFs or images.
1212

src/routes/solid-start/building-your-application/css-and-styling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ This is because, behind the scenes, classes defined in CSS modules are renamed t
7878
When classes are hard coded using the class attribute (`class="card"`), Solid is not aware that it should rename `card` to something different.
7979

8080
To fix this, you can import classes used in your CSS module.
81-
The import object can be thought of as `humanClass: generatedClass` and within the component, they key (ie. the class on the element) is used to get the unique, generated class name.
81+
The import object can be thought of as `humanClass: generatedClass` and within the component, the key (ie. the class on the element) is used to get the unique, generated class name.
8282

8383
```jsx
8484
import styles from "./Card.module.css";

src/routes/solid-start/building-your-application/head-and-metadata.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export default function About() {
3838
These tags will be applied for that specific route only and will be removed from `document.head` once a user navigates away from the page.
3939
`routeData` can also be used here to create titles and SEO metadata that is specific to the dynamic parts of the route.
4040

41-
## Adding a site-suffix in Title
41+
## Adding a site suffix in Title
4242

4343
Custom components can be created to wrap the `Title` component to add a site-specific prefix to all the titles:
4444

@@ -112,7 +112,7 @@ export default function Root() {
112112
}
113113
```
114114

115-
If you need to add route specific information inside your route, much like the `Title` component, you can use the `Meta` component within the desired route.
115+
If you need to add route-specific information inside your route, much like the `Title` component, you can use the `Meta` component within the desired route.
116116
This overrides the `Meta` tags used within the `Head` component.
117117

118118
```tsx

src/routes/solid-start/building-your-application/route-prerendering.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Route pre-rendering"
33
---
44

55
SolidStart offers a way to pre-render pages at build time.
6-
The easiest way to accomplish this, is by passing a list of routes to be pre-rendered to the `routes` option.
6+
The easiest way to accomplish this is by passing a list of routes to be pre-rendered to the `routes` option.
77

88
```js { 6 }
99
import { defineConfig } from "@solidjs/start/config";
@@ -31,4 +31,4 @@ export default defineConfig({
3131
});
3232
```
3333

34-
For more information on prerender options, check out [Nitro's documentation](https://nitro.unjs.io/config#prerender)
34+
For more information on prerender options, check out [Nitro's documentation](https://nitro.unjs.io/config#prerender)

src/routes/solid-start/building-your-application/routing.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Routing"
33
---
44

5-
Routing serves as a key component to web applications.
5+
Routing serves as a key component of web applications.
66
Within SolidStart, there are two types:
77

88
- **UI routes** — define the user interface in your app
@@ -16,11 +16,11 @@ SolidStart uses file based routing which is a way of defining your routes by cre
1616
This includes your pages and API routes.
1717

1818
SolidStart traverses your `routes` directory, collects all of the routes, and then makes them accessible using the [`<FileRoutes />`](/solid-start/reference/routing/file-routes).
19-
This component will only include your UI routes, and not your API routes.
19+
This component will only include your UI routes and not your API routes.
2020
Rather than manually defining each `Route` inside a `Router` component, `<FileRoutes />` will generate the routes for you based on the file system.
2121

2222
Because `<FileRoutes />` returns a routing config object, you can use it with the router of your choice.
23-
In this example we use [`solid-router`](/solid-router):
23+
In this example, we use [`solid-router`](/solid-router):
2424

2525
```tsx {7-9} title="app.tsx"
2626
import { Suspense } from "solid-js";
@@ -37,7 +37,7 @@ export default function App() {
3737
```
3838

3939
The `<Router />` component expects a `root` prop which functions as the root layout of your entire app.
40-
You will want to make sure `props.children` is wrapped in `<Suspense />` because each component will be lazy loaded automatically for you. Without this you may see some unexpected hydration errors.
40+
You will want to make sure `props.children` is wrapped in `<Suspense />` because each component will be lazy-loaded automatically for you. Without this you may see some unexpected hydration errors.
4141

4242
`<FileRoutes />` will generate a route for each file in the `routes` directory and its subdirectories. For a route to be rendered as a page, it must default export a component.
4343
This component represents the content that will be rendered when users visit the page:
@@ -84,7 +84,7 @@ If you want to create nested layouts you can create a file with the same name as
8484
|-- article-2.tsx // example.com/blog/article-2
8585
```
8686

87-
In this case the `blog.tsx` file will act as a layout for the articles in the `blog` folder. You can reference the child content
87+
In this case, the `blog.tsx` file will act as a layout for the articles in the `blog` folder. You can reference the child's content
8888
by using `props.children` in the layout.
8989

9090
<TabsCodeBlocks>
@@ -113,7 +113,7 @@ export default function BlogLayout(props) {
113113
By default, the component that is rendered for a route comes from the default export of the `index.tsx` file in each folder.
114114
However, this can make it difficult to find the correct `index.tsx` file when searching, since there will be multiple files with that name.
115115

116-
To avoid this, you can rename the `index.tsx` file to the name of the folder it is in, enclosed in parenthesis.
116+
To avoid this, you can rename the `index.tsx` file to the name of the folder it is in, enclosed in parentheses.
117117

118118
This way, it will be treated as the default export for that route:
119119

src/routes/solid-start/building-your-application/static-assets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ For example, `solid.png` will become `solid.2d8efhg.png`.
6969
## Public directory versus imports
7070

7171
The public directory and imports are both valid ways to include static assets in your project.
72-
The driver to using one over the other is based on your use case.
72+
The driver to use one over the other is based on your use case.
7373

7474
For dynamic updates to your assets, using the public directory is the best choice.
7575
It allows you to maintain full control over the asset URL paths, ensuring that the links remain consistent even when the assets are updated.
7676

7777
When using imports, the filename is hashed and therefore will not be predictable over time.
78-
This can be beneficial for cache busting but detrimental if you want to send someone a link to the asset.
78+
This can be beneficial for cache busting but detrimental if you want to send someone a link to the asset.

0 commit comments

Comments
 (0)