Skip to content

Update SEO metadata structure to include author name in site titles#67

Merged
algotyrnt merged 2 commits into
mainfrom
dev
May 17, 2026
Merged

Update SEO metadata structure to include author name in site titles#67
algotyrnt merged 2 commits into
mainfrom
dev

Conversation

@algotyrnt
Copy link
Copy Markdown
Owner

@algotyrnt algotyrnt commented May 17, 2026

This pull request updates how the site name and author name are used throughout the project to improve consistency and SEO. The main changes ensure that page titles, Open Graph, and Twitter metadata now include both the site and author names, and clarify the purpose of related environment variables.

Metadata and SEO improvements:

  • Updated all page titles, Open Graph, and Twitter metadata to use the format ${SITE_NAME} - ${AUTHOR_NAME} for better branding and SEO. (src/app/layout.tsx) [1] [2]
  • Changed the Open Graph siteName and JSON-LD name fields to use AUTHOR_NAME instead of SITE_NAME for more accurate author attribution. (src/app/layout.tsx) [1] [2]

Environment variable and documentation updates:

  • Updated .env.example to clarify the use of SITE_NAME and document that page titles are now automatically formatted with both site and author names. (.env.example)
  • Improved the description of SITE_NAME in the README.md to specify it as the base site name (e.g., brand or domain). (README.md)

Summary by CodeRabbit

  • Documentation

    • Updated environment variable documentation to clarify site name represents a brand or domain.
  • Chores

    • Updated page title and metadata formatting to display "Site Name - Author Name" across browser tabs and social media previews.
    • Updated configuration examples and SEO metadata fields to reflect new naming convention.

Review Change Stack

@algotyrnt algotyrnt self-assigned this May 17, 2026
Copilot AI review requested due to automatic review settings May 17, 2026 11:25
@algotyrnt algotyrnt added the enhancement New feature or request label May 17, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
personal-site Ready Ready Preview, Comment May 17, 2026 11:38am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 17, 2026

Warning

Rate limit exceeded

@algotyrnt has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 47 minutes and 8 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 7ecd26f2-2596-4500-b4cc-3d1675194937

📥 Commits

Reviewing files that changed from the base of the PR and between d62fbf0 and ec68c98.

📒 Files selected for processing (2)
  • .env.example
  • src/app/layout.tsx

Walkthrough

The PR updates environment configuration and metadata to separate site branding from author identity. The SITE_NAME variable changes from a combined name-title value to a standalone site identifier, and page titles, Open Graph metadata, and JSON-LD schemas are updated to compose titles from both SITE_NAME and AUTHOR_NAME.

Changes

Site Name and Author Name Separation

Layer / File(s) Summary
Configuration and documentation updates
.env.example, README.md
SITE_NAME is updated from Your Name - Your Title to Your Site Name with a clarifying comment that page titles use {SITE_NAME} - {AUTHOR_NAME}. README documentation is updated to describe SITE_NAME as a base site name suitable for brand or domain values.
Page and schema metadata implementation
src/app/layout.tsx
The metadata export is updated to compose page titles from both ${SITE_NAME} and ${AUTHOR_NAME} across default, Open Graph, and Twitter title fields; Open Graph image alt text is updated to the combined format; and the JSON-LD WebSite schema now uses AUTHOR_NAME instead of SITE_NAME for the entity name.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 A site needs identity twofold,
Brand and author, stories told,
The metadata now knows the way,
To show both names in every display! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating SEO metadata to include author name in site titles, which is reflected across all modified files (.env.example, README.md, and src/app/layout.tsx).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates SEO metadata to combine SITE_NAME and AUTHOR_NAME in page titles and Open Graph/Twitter fields, and clarifies the meaning of SITE_NAME in .env.example and README.md.

Changes:

  • Page/OG/Twitter titles now use ${SITE_NAME} - ${AUTHOR_NAME} format.
  • Open Graph siteName and JSON-LD name now use AUTHOR_NAME instead of SITE_NAME.
  • Documentation updated to reflect the new semantics of SITE_NAME.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/app/layout.tsx Combines site and author names across metadata fields.
README.md Clarifies SITE_NAME as base site name.
.env.example Updates example value and documents auto-formatting of titles.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
.env.example (1)

16-16: 💤 Low value

Consider quoting the multi-word value.

While most .env parsers handle unquoted multi-word values correctly, wrapping Your Site Name in quotes is more robust and aligns with common .env conventions.

💬 Proposed fix
-SITE_NAME=Your Site Name
+SITE_NAME="Your Site Name"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.env.example at line 16, The SITE_NAME entry in the .env.example uses an
unquoted multi-word value which can be fragile with some parsers; update the
SITE_NAME variable (SITE_NAME) to wrap the value in quotes (e.g.,
SITE_NAME="Your Site Name") so multi-word content is preserved reliably and
follows common .env conventions.
src/app/layout.tsx (1)

31-31: 💤 Low value

Consider using a consistent separator across title formats.

The default title uses a hyphen (-), while the template uses a pipe (|). This creates titles like:

  • Home: Your Site Name - Your Name
  • Other pages: Page Title | Your Site Name

Consider standardizing on one separator for visual consistency.

🎨 Proposed fix for consistency
-    template: '%s | ' + SITE_NAME,
+    template: `%s - ${SITE_NAME}`,
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/app/layout.tsx` at line 31, The title template in layout.tsx currently
uses a pipe separator ('template: '%s | ' + SITE_NAME') which is inconsistent
with the default title separator (a hyphen); update the title formatting so both
the default title and the template use the same separator for visual
consistency—pick one separator (e.g., '-' or '|') and replace the separator in
the template line that builds the title (the "template" value) to match the
separator used where the default title is defined (referencing SITE_NAME and the
default title configuration) so all pages render with a consistent separator.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/app/layout.tsx`:
- Line 86: The WebSite schema in layout.tsx incorrectly uses AUTHOR_NAME for the
site's name; change the WebSite metadata object's name property to SITE_NAME so
the WebSite entity identifies the site/brand while leaving the Person entity
(which uses AUTHOR_NAME) untouched—locate the WebSite JSON-LD object where name:
AUTHOR_NAME is set and replace that value with SITE_NAME.
- Line 48: Replace the incorrect use of AUTHOR_NAME for the Open Graph site name
by setting siteName to the site-level identifier constant (e.g., SITE_NAME)
instead of AUTHOR_NAME; locate the siteName property in the layout (siteName:
AUTHOR_NAME) and change it to siteName: SITE_NAME so og:site_name correctly
represents the site/brand while leaving AUTHOR_NAME for Person/author metadata.

---

Nitpick comments:
In @.env.example:
- Line 16: The SITE_NAME entry in the .env.example uses an unquoted multi-word
value which can be fragile with some parsers; update the SITE_NAME variable
(SITE_NAME) to wrap the value in quotes (e.g., SITE_NAME="Your Site Name") so
multi-word content is preserved reliably and follows common .env conventions.

In `@src/app/layout.tsx`:
- Line 31: The title template in layout.tsx currently uses a pipe separator
('template: '%s | ' + SITE_NAME') which is inconsistent with the default title
separator (a hyphen); update the title formatting so both the default title and
the template use the same separator for visual consistency—pick one separator
(e.g., '-' or '|') and replace the separator in the template line that builds
the title (the "template" value) to match the separator used where the default
title is defined (referencing SITE_NAME and the default title configuration) so
all pages render with a consistent separator.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 41592470-aa64-4a72-8d2b-2d162f156a14

📥 Commits

Reviewing files that changed from the base of the PR and between 3c3ad57 and d62fbf0.

📒 Files selected for processing (3)
  • .env.example
  • README.md
  • src/app/layout.tsx

Comment thread src/app/layout.tsx Outdated
Comment thread src/app/layout.tsx Outdated
@algotyrnt algotyrnt merged commit 57cb1e2 into main May 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants