fix: SEO Fixes, broken link fixes

[perkinsjr]

Add robots.txt to middleware to stop 500 errors

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Test A
• Test B

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

Release Notes

• New Features

  • Added sitemap generation for improved search engine indexing
  • Introduced routing configuration for /terms page

• Content Updates

  • Updated changelog for March 2024
  • Modified blog post content
  • Updated link for standalone ratelimiting feature

• SEO Configuration

  • Added robots.txt files for dashboard and www applications
  • Configured sitemap with comprehensive URL mappings

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 2:12pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 2:12pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 2:12pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 2:12pm

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces several changes across the Unkey application, focusing on web crawling configurations, routing, and content updates. The modifications include adding robots.txt files for different applications with distinct crawler policies, updating the sitemap generation, introducing a new routing rewrite for terms, and making minor content adjustments in the changelog and blog post. The changes aim to improve website structure, SEO, and content management.

Changes

File	Change Summary
apps/dashboard/app/robots.txt	New file created with crawler disallow rule for entire site
apps/dashboard/middleware.ts	Added /robots.txt to middleware matcher array
apps/www/app/policies/[slug]/page.tsx	Removed robots metadata object from generateMetadata function
apps/www/app/robots.txt	New file created allowing all crawlers with sitemap link
apps/www/app/sitemap.ts	Added new async sitemap() function to generate website sitemap
apps/www/content/blog/how-unkey-treats-marketing.mdx	Removed email contact information from conclusion
apps/www/content/changelog/2024-03-01.mdx	Updated changelog link and added ratelimiting feature details
apps/www/next.config.js	Added rewrite rule from /terms to /policies/terms

Possibly related PRs

• feat: allow-developer-to-set-a-custom-refill-time-when-using-the #2114: Related to robots.txt file and middleware route handling
• feat: Who Am I route #2159: Connected to web crawler and API interactions
• feat: add rewrites and upserts for gateway.new #2779: Relevant to routing logic for new domains
• chore: Adding changelog december #2782: Involves API endpoint documentation updates

Suggested labels

bug, feature, needs-approval

Suggested reviewers

• mcstepp
• chronark
• ogzhanolguncu
• MichaelUnkey

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[changeset-bot]

⚠️ No Changeset found

Latest commit: 90c350b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[chronark]

nice

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (4)

apps/www/next.config.js (1)

40-43: Consider using a redirect for SEO tracking.

Rewriting /terms to /policies/terms is valid, but using a redirect may improve SEO by informing search engines that the route has permanently moved. For large directories or high-traffic endpoints, this can help preserve link equity.

apps/www/app/sitemap.ts (3)

1-3: Consider validating content arrays from external sources.
If allPosts, allPolicies, allChangelogs, or allGlossaries are empty or undefined, it might cause unexpected behavior in your sitemap. You could provide a fallback (e.g., an empty array) or log a warning for better resilience.

---

4-5: Allow configuration of the base URL.
Currently, the baseUrl is hardcoded as "https://unkey.com". If you ever need to generate sitemaps for other environments (e.g., testing or staging), consider making baseUrl configurable via environment variables to avoid accidental misconfiguration.

---

26-61: Potential improvement: standardize lastModified values.
Currently, some entries have new Date() while others derive lastModified from content fields. For consistency and best SEO practices, consider standardizing how lastModified is assigned (e.g., always using the content’s own date, or always using new Date() plus a fallback if missing).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3cd602d and 90c350b.

📒 Files selected for processing (8)

• apps/dashboard/app/robots.txt (1 hunks)
• apps/dashboard/middleware.ts (1 hunks)
• apps/www/app/policies/[slug]/page.tsx (0 hunks)
• apps/www/app/robots.txt (1 hunks)
• apps/www/app/sitemap.ts (1 hunks)
• apps/www/content/blog/how-unkey-treats-marketing.mdx (1 hunks)
• apps/www/content/changelog/2024-03-01.mdx (1 hunks)
• apps/www/next.config.js (1 hunks)

💤 Files with no reviewable changes (1)

• apps/www/app/policies/[slug]/page.tsx

✅ Files skipped from review due to trivial changes (4)

• apps/www/content/blog/how-unkey-treats-marketing.mdx
• apps/www/app/robots.txt
• apps/dashboard/app/robots.txt
• apps/www/content/changelog/2024-03-01.mdx

🔇 Additional comments (1)

apps/www/app/sitemap.ts (1)

16-19: Avoid using anchors (#${changelog.slug}) in sitemap URLs.
Many crawlers treat fragment identifiers as non-navigable references to sections within a page, making them less useful for indexing distinct content. If each changelog entry truly has its own page, consider using unique routes or query params.