feat: seo audit

[iatopilskii]

Summary

Comprehensive SEO audit fixes based on SiteOne Crawler report across the documentation site.

Security Headers

• Added X-Frame-Options, X-XSS-Protection, X-Content-Type-Options, Referrer-Policy, and Permissions-Policy headers in netlify.toml
• Disabled X-Powered-By header via poweredByHeader: false in next.config.mjs

Redirect Fixes (30+ new redirects in src/middleware.ts)

Added 308 permanent redirects for broken/moved URLs to eliminate 404s and preserve link equity:

• Legacy inbox paths (/platform/inbox/headless/*, /platform/inbox/react/*)
• Moved community pages (/platform/run-in-local-machine → /community/run-in-local-machine)
• Old integration paths (/platform/integrations/email/outlook-365, /platform/integrations/sms/azure-sms, etc.)
• Renamed workflow paths (/platform/workflow/translations, /platform/workflow/add-notification-content, action step paths)
• Framework paths (/platform/framework/typescript/steps, /framework/steps)
• Miscellaneous (/platform/concepts/endpoint, /platform/concepts/environments, /platform/concepts/notifications, etc.)

Internal Link Updates (90 files)

Replaced old/redirected URLs with canonical destinations across all content files:

• /platform/inbox/overview → /platform/inbox
• /platform/workflow/overview → /platform/workflow
• /platform/integrations/overview → /platform/integrations
• /framework/overview → /framework
• /api-reference/overview → /api-reference
• /platform/sdks/overview → /platform/sdks
• /platform/workflow/delay → /platform/workflow/add-and-configure-steps#delay
• /platform/workflow/digest → /platform/workflow/add-and-configure-steps#digest
• /platform/workflow/step-conditions → /platform/workflow/add-and-configure-steps/step-conditions
• /platform/workflow/tags → /platform/workflow/configure-workflow#tags
• /platform/inbox/react/components/* → updated canonical paths
• /community/project-differences → /community/self-hosted-and-novu-cloud

Heading Hierarchy Fixes

Fixed h3 → h2 heading levels in 10 files to ensure proper document outline (no ### without a preceding ##):

• community/run-in-local-machine.mdx
• community/code-of-conduct.mdx
• All framework quickstart guides (express, h3, lambda, nuxt, remix, svelte)
• Platform quickstart guides (angular, react)

Image Alt Text

Added descriptive alt text to images missing it in:

• platform/integrations/push/push-activity-tracking.mdx
• platform/integrations/push/(providers)/fcm.mdx

Meta Descriptions

Added missing description frontmatter to pages that lacked it (e.g., guides/index.mdx, deployment docs, SDK docs).

Summary by CodeRabbit

• Documentation

  • Reorganized and simplified documentation navigation paths across guides, API references, and platform docs for improved clarity
  • Enhanced documentation metadata with page titles and descriptions for better SEO and discoverability
  • Expanded local development setup guide with comprehensive prerequisites, environment variables, and step-by-step instructions
  • Updated and expanded Code of Conduct with detailed enforcement guidelines and community standards

• Chores

  • Added security headers to web server configuration
  • Implemented legacy URL redirects to maintain backward compatibility with previous documentation links

[netlify]

✅ Deploy Preview for docs-novu ready!

Name	Link
🔨 Latest commit	26699a3
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/69b2f227378faa0007dac60f
😎 Deploy Preview	https://deploy-preview-1061--docs-novu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

Comprehensive documentation restructuring and link migration across the platform, consolidating overview pages, reorganizing path hierarchies, and updating internal hyperlinks throughout the documentation suite. Additionally, configuration changes add security headers and update metadata generation logic.

Changes

Cohort / File(s)	Summary
Environment & Topic Documentation content/docs/api-reference/environments/*, content/docs/platform/concepts/topics.mdx	Updated hyperlinks from /platform/concepts/environments to /platform/developer/environments to reflect new developer documentation structure.
API Reference Documentation content/docs/api-reference/messages/*	Updated inbox reference links from /platform/inbox/overview to /platform/inbox across message schema documentation.
Community & Setup Documentation content/docs/community/add-a-new-provider.mdx, content/docs/community/code-of-conduct.mdx, content/docs/community/index.mdx, content/docs/community/run-in-local-machine.mdx, content/docs/community/self-hosting-novu/*	Updated internal links, reorganized heading levels, expanded setup content with prerequisites and environment variables, restructured code-of-conduct with enforcement guidelines, and updated migration documentation links.
Framework Documentation - Links & Metadata content/docs/framework/delay.mdx, content/docs/framework/digest.mdx, content/docs/framework/endpoint.mdx, content/docs/framework/introduction.mdx, content/docs/framework/payload.mdx, content/docs/framework/schema/json-schema.mdx, content/docs/framework/tags.mdx, content/docs/framework/typescript/*	Updated endpoint path references from /platform/concepts/endpoint to /framework/endpoint, adjusted internal documentation links, and added description fields to front matter.
Framework Deployment Documentation content/docs/framework/deployment/*	Added description metadata fields to MDX front matter for deployment guides (actions, CLI, syncing).
Framework Quickstart Guides content/docs/framework/quickstart/*	Updated bridge endpoint references from /platform/concepts/endpoint to /framework/endpoint, converted multiple heading levels from H3 to H2, and expanded code examples with workflow imports and server setup in AWS Lambda guide.
Guide Documentation content/docs/guides/index.mdx, content/docs/guides/webhooks/*	Updated navigation links from /framework/overview to /framework and enhanced guide metadata with page titles and descriptions.
Platform Account & Roles Documentation content/docs/platform/account/manage-members.mdx	Updated role and permissions link from /platform/additional-resources/roles-and-permissions to /platform/account/roles-and-permissions.
Platform Concepts Documentation content/docs/platform/concepts/preferences.mdx, content/docs/platform/concepts/tenants.mdx, content/docs/platform/concepts/trigger.mdx, content/docs/platform/concepts/workflows.mdx	Updated inbox component paths, step condition references, and consolidated overview links to remove /overview suffix.
Platform Developer Documentation content/docs/platform/developer/api-keys.mdx, content/docs/platform/developer/environments.mdx	Updated inbox references from /platform/inbox/overview to /platform/inbox and corrected branding terminology.
Platform Integration Documentation content/docs/platform/integrations/...	Updated provider card hrefs (Outlook 365, Email Webhook, Azure SMS, BulkSMS), added pageTitle metadata, corrected image alt text, and updated internal documentation links.
Platform Inbox Documentation content/docs/platform/inbox/*	Migrated all inbox links from /platform/inbox/overview and /platform/inbox/react/components/inbox to /platform/inbox, updated configuration tab styling and preference links, and added code examples for severity filtering.
Platform Quickstart Guides content/docs/platform/quickstart/*	Updated framework and workflow overview links, consolidated inbox component references, converted heading levels from H3 to H2 in multiple guides, and expanded component setup examples.
Platform SDK Documentation content/docs/platform/sdks/*	Updated headless API reference links from /platform/inbox/headless/api-reference to /platform/inbox/headless-mode, updated React SDK card links, and added pageTitle metadata fields.
Platform Subscription Documentation content/docs/platform/subscription/*	Updated inbox references and localization links from /platform/inbox/advanced-concepts/localization to /platform/inbox/advanced-features/localization.
Platform Workflow Documentation content/docs/platform/workflow/*	Updated inbox overview links, consolidated integration references, updated translations path from /platform/workflow/translations to /platform/workflow/advanced-features/translations, and updated notification content links to use channel-specific editor path.
Platform Metadata Documentation content/docs/platform/additional-resources/legacy-documentation.mdx, content/docs/platform/index.mdx, content/docs/platform/how-novu-works.mdx, content/docs/platform/novu-for/developers.mdx, content/docs/platform/what-is-novu.mdx	Added description fields, updated pageTitle metadata, consolidated overview links, and updated SDK reference paths.
Configuration & Middleware netlify.toml, next.config.mjs, src/middleware.ts	Added security headers (X-Frame-Options, X-XSS-Protection, X-Content-Type-Options, Referrer-Policy, Permissions-Policy), disabled X-Powered-By header, and expanded redirect mappings for legacy documentation paths.
Metadata Generation src/app/[[...slug]]/page.tsx	Updated metadata title generation to prioritize pageTitle field when available, falling back to title.
Component Updates src/components/pages/overview-page.tsx	Updated notifications concept link from /platform/concepts/notifications to /platform/concepts/notification-event.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

• Update content for environments page (#1008) #1013: Introduces and moves the environments page to /platform/developer/environments, which this PR extensively links to across documentation files.
• [DO NOT MERGE] WIP ⚠️ Inbox docs overhaul main PR #905: Comprehensive Inbox documentation overhaul and restructuring that directly aligns with the widespread inbox path consolidations in this PR.
• fix: broken bridge endpoint link in framework doc #972: Updates Bridge Endpoint documentation links from /platform/concepts/endpoint to /framework/endpoint, the same pattern applied across framework quickstart guides in this PR.

Suggested labels

High Priority

Suggested reviewers

• Aviatorscode2
• jainpawan21
• scopsy

Poem

🐰 A rabbit hops through docs so neat,
With links reorganized, paths complete,
From overview pages now consolidated,
Framework and platform—reallocated!
Security headers stand guard with care,
Documentation restructured everywhere! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'feat: seo audit' refers to the main change (SEO improvements from an audit), but is vague and lacks specificity about what was actually fixed.	Consider a more descriptive title that conveys the scope, such as 'feat: apply SEO audit fixes including redirects, headers, and link updates' or 'feat: comprehensive SEO improvements from SiteOne Crawler audit'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/seo-audit

📝 Coding Plan

• Generate coding plan for human review comments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure the reviews.tools.github-checks setting to adjust the time to wait for GitHub Checks to complete.