Skip to content

Commit b9034f9

Browse files
skiniksskiniks
committed
docs: refactor documentation to use passive voice and generic language
1 parent 1205d04 commit b9034f9

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed

‎web/public/content/docs/api-reference/functions/fetch.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const description = 'Enhanced fetch function with automatic request dedup
33

44
<PageHeader title="fetch" />
55

6-
rari extends the native Web `fetch()` API with automatic request deduplication and caching. Use it in Server Components and Route Handlers to fetch data efficiently with built-in performance optimizations powered by Rust.
6+
The native Web `fetch()` API is extended with automatic request deduplication and caching. Use it in Server Components and Route Handlers to fetch data efficiently with built-in performance optimizations powered by Rust.
77

88
## Import
99

@@ -60,7 +60,7 @@ Standard fetch options plus rari-specific caching options.
6060

6161
## Caching Options
6262

63-
rari extends the standard `fetch()` options with caching controls:
63+
The standard `fetch()` options are extended with caching controls:
6464

6565
### cache
6666

@@ -118,7 +118,7 @@ await fetch('https://api.example.com/posts', {
118118

119119
## Request Deduplication
120120

121-
rari automatically deduplicates identical requests made during the same render pass. If multiple components request the same URL with the same options, only one network request is made.
121+
Identical requests made during the same render pass are automatically deduplicated. If multiple components request the same URL with the same options, only one network request is made.
122122

123123
<CodeBlock filename="src/app/page.tsx" language="tsx">{`async function UserProfile({ userId }: { userId: string }) {
124124
// This fetch is deduplicated if called multiple times
@@ -403,7 +403,7 @@ After the revalidation period expires, the next request will fetch fresh data.
403403

404404
### Cache Storage
405405

406-
rari uses a two-tier caching system:
406+
A two-tier caching system is used:
407407

408408
1. **Request deduplication**: Identical requests during the same render are deduplicated in memory
409409
2. **LRU cache**: Successful responses are stored in a global LRU cache (max 1000 entries) with TTL support

‎web/public/content/docs/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ export default function Counter() {
152152

153153
## Using NPM Packages
154154

155-
rari's Rust runtime handles standard `node_modules` resolution — you can `import` from any npm package the same way you would in Node. Unlike most Rust-based JS runtimes, there are no URL imports or special npm specifiers. Your existing `package.json` workflow just works.
155+
The Rust runtime handles standard `node_modules` resolution — you can `import` from any npm package the same way you would in Node. Unlike most Rust-based JS runtimes, there are no URL imports or special npm specifiers. Your existing `package.json` workflow just works.
156156

157157
<PackageManagerTabs
158158
commands={{

‎web/public/content/docs/getting-started/database.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ export const description = "Connect to databases in rari using Server Components
33

44
<PageHeader title="Database" />
55

6-
rari's architecture makes database integration fast and straightforward. Server Components run on the server by default, giving you direct access to databases without API routes. Server Actions let you mutate data from the client while keeping your database credentials secure.
6+
Database integration is fast and straightforward. Server Components run on the server by default, giving you direct access to databases without API routes. Server Actions let you mutate data from the client while keeping your database credentials secure.
77

8-
## Why rari for Databases
8+
## Why This Approach Works
99

1010
rari's Rust runtime delivers exceptional performance for database-heavy applications:
1111

@@ -38,7 +38,7 @@ rari's Rust runtime delivers exceptional performance for database-heavy applicat
3838

3939
## Database Clients
4040

41-
rari supports any Node.js-compatible database client. Here are the most popular options:
41+
Any Node.js-compatible database client works here. Here are the most popular options:
4242

4343
### Postgres Clients
4444

@@ -446,7 +446,7 @@ export async function POST(request: Request) {
446446

447447
## Request Deduplication
448448

449-
rari automatically deduplicates identical `fetch()` requests made during the same render pass. If multiple components fetch the same URL with the same options, only one network request is made.
449+
Identical `fetch()` requests made during the same render pass are automatically deduplicated. If multiple components fetch the same URL with the same options, only one network request is made.
450450

451451
For database queries and other async operations, use `React.cache()` to manually deduplicate calls:
452452

@@ -690,7 +690,7 @@ if (duration > 100) {
690690

691691
## Other Databases
692692

693-
rari works with any database that has a Node.js client:
693+
Any database with a Node.js client will work:
694694

695695
### MySQL
696696

‎web/public/content/docs/getting-started/deploying.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const description = 'Build and deploy your rari application to Railway, R
33

44
<PageHeader title="Deploying" />
55

6-
rari applications run on a Rust server with an embedded V8 runtime. The deployment workflow is straightforward: build your app, then start the server.
6+
Applications run on a Rust server with an embedded V8 runtime. The deployment workflow is straightforward: build your app, then start the server.
77

88
## Building for Production
99

@@ -74,11 +74,11 @@ If you have an existing `start` script, it's backed up to `start:original`.
7474
4. Railway detects the configuration and deploys automatically
7575
5. Generate a domain under Settings → Networking
7676

77-
rari auto-detects Railway via the `RAILWAY_ENVIRONMENT` environment variable and binds to `0.0.0.0` with the platform-assigned `PORT`.
77+
Railway is auto-detected via the `RAILWAY_ENVIRONMENT` environment variable, and the server binds to `0.0.0.0` with the platform-assigned `PORT`.
7878

7979
### System Dependencies
8080

81-
rari's Rust runtime requires `libfontconfig1` for image and font rendering. On Railway, add this variable to your service:
81+
The Rust runtime requires `libfontconfig1` for image and font rendering. On Railway, add this variable to your service:
8282

8383
| Variable | Value |
8484
|---|---|
@@ -119,11 +119,11 @@ The same `package.json` changes apply as with Railway — `scripts.start`, `engi
119119
4. Render auto-detects the `render.yaml` configuration
120120
5. Click "Create Web Service"
121121

122-
rari auto-detects Render via the `RENDER` environment variable and binds to `0.0.0.0` with the platform-assigned `PORT`.
122+
Render is auto-detected via the `RENDER` environment variable, and the server binds to `0.0.0.0` with the platform-assigned `PORT`.
123123

124124
### System Dependencies
125125

126-
rari's Rust runtime requires `libfontconfig1` for image and font rendering. Render's native Node.js runtime includes `libvips-dev`, which provides `libfontconfig1` as a transitive dependency — so this should work out of the box. If you run into font-related errors, switch to a [Docker deployment](https://render.com/docs/docker) and install `libfontconfig1` explicitly (see the [Self-Hosting](#self-hosting) Dockerfile below).
126+
The Rust runtime requires `libfontconfig1` for image and font rendering. Render's native Node.js runtime includes `libvips-dev`, which provides `libfontconfig1` as a transitive dependency — so this should work out of the box. If you run into font-related errors, switch to a [Docker deployment](https://render.com/docs/docker) and install `libfontconfig1` explicitly (see the [Self-Hosting](#self-hosting) Dockerfile below).
127127

128128
## Self-Hosting
129129

@@ -168,7 +168,7 @@ EXPOSE 3000
168168
CMD ["npm", "start"]
169169
`}</CodeBlock>
170170

171-
rari binds to `0.0.0.0` automatically on Railway and Render, but defaults to `127.0.0.1` elsewhere. For containerized or cloud deployments, make sure your networking layer routes traffic to the server's bound address and port.
171+
The server binds to `0.0.0.0` automatically on Railway and Render, but defaults to `127.0.0.1` elsewhere. For containerized or cloud deployments, make sure your networking layer routes traffic to the server's bound address and port.
172172

173173
## Related
174174

‎web/public/content/docs/getting-started/links.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const description = 'Learn how navigation works in rari using standard HT
33

44
<PageHeader title="Links and Navigation" />
55

6-
rari takes a different approach to navigation. Instead of requiring a special `<Link>` component, you use standard HTML `<a>` tags. The framework's client router automatically intercepts link clicks and performs client-side navigation — giving you the benefits of a single-page application without the API overhead.
6+
Use standard HTML `<a>` tags for navigation. The client router automatically intercepts link clicks and performs client-side navigation — giving you the benefits of a single-page application without needing a special `<Link>` component or API overhead.
77

88
## Basic Usage
99

‎web/public/content/docs/getting-started/metadata.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const description = 'Learn how to configure page metadata, SEO tags, Open
33

44
<PageHeader title="Metadata" />
55

6-
rari provides a powerful metadata system for configuring page titles, descriptions, Open Graph tags, Twitter cards, and more. Metadata can be defined statically or generated dynamically based on route parameters.
6+
Configure page titles, descriptions, Open Graph tags, Twitter cards, and more with a powerful metadata system. Define metadata statically or generate it dynamically based on route parameters.
77

88
## Basic Metadata
99

‎web/public/content/docs/getting-started/routing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const description = 'Learn how file-based routing works in rari — pages
33

44
<PageHeader title="Routing" />
55

6-
rari uses file-based routing. Your file structure inside `src/app/` becomes your URL structure. Add a `page.tsx` and you have a route. Add a `layout.tsx` and it wraps every page beneath it. No router config, no manifest files.
6+
File-based routing means your file structure inside `src/app/` becomes your URL structure. Add a `page.tsx` and you have a route. Add a `layout.tsx` and it wraps every page beneath it. No router config, no manifest files.
77

88
## File Conventions
99

0 commit comments

Comments
 (0)