Skip to content

Commit 823846b

Browse files
committed
chore: replace better-og with Better OG everywhere
1 parent 015fbe7 commit 823846b

10 files changed

Lines changed: 15 additions & 14 deletions

File tree

docs/content/docs/en/api-reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: API Reference
3-
description: Complete API reference for all better-og exports.
3+
description: Complete API reference for all Better OG exports.
44
---
55

66
## Core (`@better-og/core`)

docs/content/docs/en/core-concepts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Understand aspect ratios, platform detection, safe areas, layout, a
55

66
## Platform Detection
77

8-
When a social platform fetches your OG image, it sends a characteristic request signature. better-og combines explicit query overrides with `User-Agent`, `Referer`, and other request hints to determine which platform is requesting the image and selects the optimal aspect ratio preset.
8+
When a social platform fetches your OG image, it sends a characteristic request signature. Better OG combines explicit query overrides with `User-Agent`, `Referer`, and other request hints to determine which platform is requesting the image and selects the optimal aspect ratio preset.
99

1010
| Platform | User-Agent pattern | Default Preset |
1111
| --------- | ------------------ | -------------- |
@@ -49,7 +49,7 @@ interface ResolvedOgRequest {
4949

5050
## Safe Areas
5151

52-
Some platforms crop OG images. Twitter, for example, crops the bottom 44px of a standard OG image to overlay engagement buttons. better-og exposes this as `safeArea.bottom`:
52+
Some platforms crop OG images. Twitter, for example, crops the bottom 44px of a standard OG image to overlay engagement buttons. Better OG exposes this as `safeArea.bottom`:
5353

5454
```tsx
5555
const handler = createOgRouteHandler({

docs/content/docs/en/fonts.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Script-aware font loading with automatic fallbacks for multilingual
55

66
## Font Loading
77

8-
better-og provides two approaches to loading fonts for OG image rendering:
8+
Better OG provides two approaches to loading fonts for OG image rendering:
99

1010
### Google Fonts (for next/og)
1111

@@ -52,7 +52,7 @@ const fontSetup = await resolveFontSetup({
5252

5353
## Built-in Locale Fallbacks
5454

55-
better-og ships with Google Fonts mappings for these locales:
55+
Better OG ships with Google Fonts mappings for these locales:
5656

5757
| Locale | Font Family |
5858
| ------ | -------------------- |
@@ -65,7 +65,7 @@ better-og ships with Google Fonts mappings for these locales:
6565
| `ar` | Noto Sans Arabic |
6666
| `hi` | Noto Sans Devanagari |
6767

68-
When you specify `fallbackLocales`, better-og automatically loads the appropriate Noto Sans variant and appends it to the font stack. Mixed-script strings also trigger the corresponding fallback locales automatically.
68+
When you specify `fallbackLocales`, Better OG automatically loads the appropriate Noto Sans variant and appends it to the font stack. Mixed-script strings also trigger the corresponding fallback locales automatically.
6969

7070
## Using Locale Fonts in Components
7171

@@ -84,7 +84,7 @@ Use the resolved family names from `fontSetup.families.locales` to apply the cor
8484

8585
## Locale Resolution
8686

87-
In route handlers, better-og resolves the locale from:
87+
In route handlers, Better OG resolves the locale from:
8888

8989
1. `localeFromRequest` callback (custom per-request locale detection)
9090
2. Route params (`params.lang` or `params.locale`)

docs/content/docs/en/next/edge.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Edge Runtime
3-
description: Use better-og on the Next.js Edge runtime with next/og.
3+
description: Use Better OG on the Next.js Edge runtime with next/og.
44
---
55

66
## Import

docs/content/docs/en/next/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Next.js (Node)
3-
description: Use better-og with the Next.js Node runtime, supporting both next/og and Takumi renderers.
3+
description: Use Better OG with the Next.js Node runtime, supporting both next/og and Takumi renderers.
44
---
55

66
## Import

docs/src/constants/site.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const SITE = {
2525
"aspect ratio",
2626
"i18n",
2727
],
28-
NAME: "better-og",
28+
NAME: "Better OG",
2929
OG_IMAGE:
3030
"https://yffrvzi8zwbljfuj.public.blob.vercel-storage.com/better-og/og.png",
3131
URL: baseUrl,

docs/src/lib/layout.shared.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
22

33
import { LogoMark } from "@/components/logo";
4+
import { SITE } from "@/constants/site";
45
import { i18n } from "@/lib/i18n";
56

67
export const baseOptions: (_locale: string) => BaseLayoutProps = () => ({
@@ -10,7 +11,7 @@ export const baseOptions: (_locale: string) => BaseLayoutProps = () => ({
1011
title: (
1112
<>
1213
<LogoMark className="h-6" />
13-
better-og
14+
{SITE.NAME}
1415
</>
1516
),
1617
},

packages/edge/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @better-og/edge
22

3-
Low-level Takumi WASM adapter for `better-og`.
3+
Low-level Takumi WASM adapter for `Better OG`.
44

55
## Install
66

packages/node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @better-og/node
22

3-
Node.js adapter for `better-og`.
3+
Node.js adapter for `Better OG`.
44

55
It uses Takumi's native Node.js runtime for rendering Open Graph images.
66

packages/workers/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @better-og/workers
22

3-
Workers adapter for `better-og`.
3+
Workers adapter for `Better OG`.
44

55
It initializes Takumi's bundled Workers WASM runtime and renders through a
66
`Renderer`, which matches the Cloudflare Workers setup used in Takumi's own

0 commit comments

Comments
 (0)