Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions documentation/project-docs/metadata-and-seo.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ This split follows Next.js metadata merge behavior: nested fields like `openGrap
| `lib/page-meta.ts` | Route title/description source of truth for top-level routes |
| `lib/page-info.tsx` | In-app help content and header metadata (built from route meta + help content) |
| `lib/metadata.ts` | Metadata utilities (`resolveMetadataBase`, `buildPageMetadata`, shared OG/Twitter fields) |
| `lib/og-image.tsx` | Shared `next/og` image renderer used by OG routes |
| `lib/og-image.tsx` | Shared `next/og` image renderer (optional custom OG endpoint) |
| `app/layout.tsx` | Global metadata defaults |
| `app/**/page.tsx` | Route-level `generateMetadata()` exports |
| `app/api/og/route.ts` | API-style Open Graph endpoint (`next/og`) |
| `app/api/og/route.ts` | API-style Open Graph endpoint (`next/og`, optional) |

## Open Graph Image

TeacherBuddy uses a generated OG image route:
TeacherBuddy uses a static OG image asset:

- Path: `/api/og`
- API route file: `app/api/og/route.ts`
- Rendered dimensions: `1200x630`
- Path: `/images/og.png`
- Source file: `public/images/og.png`
- Declared dimensions: `895x372`

The shared OG and Twitter image path is defined once in `lib/metadata.ts`.

Expand Down
8 changes: 4 additions & 4 deletions lib/metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const DEFAULT_SITE_DESCRIPTION =
'Manage students, build quizzes, and draw random pairs without repeats.';

const DEFAULT_SITE_URL = 'http://localhost:3000';
const DEFAULT_OG_IMAGE_PATH = '/api/og';
const DEFAULT_OG_IMAGE_PATH = '/images/og.png';
const URL_PROTOCOL_PATTERN = /^[a-zA-Z][a-zA-Z\d+\-.]*:\/\//;

/**
Expand All @@ -27,9 +27,9 @@ export const SHARED_OPEN_GRAPH: NonNullable<Metadata['openGraph']> = {
images: [
{
url: DEFAULT_OG_IMAGE_PATH,
width: 1200,
height: 630,
alt: 'TeacherBuddy classroom dashboard preview',
width: 895,
height: 372,
alt: 'TeacherBuddy logo',
},
],
};
Expand Down
Binary file added public/images/og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading