Skip to content

feat(docs): seo improvements#71

Merged
izadoesdev merged 6 commits into
databuddy-analytics:stagingfrom
vachmara:feat/seo-improvements
Aug 11, 2025
Merged

feat(docs): seo improvements#71
izadoesdev merged 6 commits into
databuddy-analytics:stagingfrom
vachmara:feat/seo-improvements

Conversation

@vachmara

@vachmara vachmara commented Aug 11, 2025

Copy link
Copy Markdown
Contributor

Pull Request

Description

This pull request focuses on improving code consistency and enhancing SEO and structured data for the Databuddy documentation and marketing pages. The most notable changes include standardizing string quoting conventions in dashboard components and introducing structured data for better search engine visibility across key pages (home, pricing, privacy, terms, blog, and documentation). Additionally, metadata has been updated for improved branding and search appearance.

Code consistency and formatting:

  • Standardized all string quotes from double to single quotes in dashboard components (profile-row.tsx, session-row.tsx), including JSX and utility function values, for improved code consistency.

SEO and structured data enhancements:

  • Added the StructuredData component to the home, pricing, privacy, terms, blog, and documentation pages, providing rich metadata (title, description, url, publication/modified dates, plans, breadcrumbs) for improved SEO and search engine indexing.

  • Updated metadata and Open Graph information for home, privacy, terms, and documentation pages to use more descriptive, branded titles and descriptions, improving appearance in search and social sharing.

Minor UI fixes:

  • Changed an element from <h1> to <span> in the logo carousel for better semantic structure and styling flexibility.

These changes collectively enhance both developer experience (through consistent code style) and product visibility (via improved SEO and structured data).

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features

    • Clickable headers to expand/collapse session and profile rows in the dashboard.
    • Home page adds Testimonials and updated section layout.
  • Documentation

    • Privacy Policy and Terms pages restructured with clearer sections and SEO enhancements.
    • Pricing page gains dedicated layout with rich metadata.
    • Blog and Docs pages include improved structured data for search visibility.
    • Site-wide titles updated for clearer positioning.
  • Style

    • Replaced decorative h1s with spans in logos/carousel to improve heading hierarchy and accessibility.

@vercel

vercel Bot commented Aug 11, 2025

Copy link
Copy Markdown

@vachmara is attempting to deploy a commit to the Databuddy Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Aug 11, 2025

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

The PR updates collapsible triggers in two dashboard components, refactors the StructuredData component to a new data-driven API, and adapts multiple docs pages to the new structured data model. It also revises docs site metadata/titles, adjusts semantic tags in logo components, adds a pricing layout with structured data, and includes minor formatting changes.

Changes

Cohort / File(s) Summary
Dashboard collapsible trigger updates
apps/dashboard/app/(main)/websites/[id]/profiles/_components/profile-row.tsx, apps/dashboard/app/(main)/websites/[id]/sessions/_components/session-row.tsx
CollapsibleTrigger now uses asChild so the inner header/div acts as the trigger; wiring preserved with onOpenChange handlers. Other edits are formatting-only.
StructuredData component refactor
apps/docs/components/structured-data.tsx
Major API redesign: switch from per-type props to a unified graph builder using page + elements (article/documentation/faq/softwareOffers). Emits a single JSON-LD script; adds pricing offer modeling, breadcrumbs, FAQ aggregation, and URL normalization. Public props changed.
Docs pages adopting new StructuredData API (home, pricing, privacy, terms)
apps/docs/app/(home)/page.tsx, apps/docs/app/(home)/pricing/layout.tsx, apps/docs/app/(home)/privacy/page.tsx, apps/docs/app/(home)/terms/page.tsx
Integrate new StructuredData usage with page/elements; add or update metadata (including Open Graph), reorganize page structures/sections, introduce pricing layout with JSON-LD for offers, and centralized SEO constants.
Docs dynamic content pages StructuredData migration
apps/docs/app/blog/[[...slug]]/page.tsx, apps/docs/app/docs/[[...slug]]/page.tsx
Replace old StructuredData props with elements[] and page; compute ISO dates and inLanguage; include derived titles/descriptions and breadcrumbs handling.
Docs site metadata title update
apps/docs/app/layout.tsx
Updated metadata, openGraph, and twitter titles to a new string; no API changes.
Logo semantic tag adjustments
apps/docs/components/landing/logo-carousel.tsx, apps/docs/components/logo.tsx
Change h1 to span for logo text elements; semantics updated, visuals preserved.
UI formatting only
apps/docs/components/ui/kibo-ui/marquee/index.tsx
Indentation/formatting changes only; no behavior or API changes.

Sequence Diagram(s)

sequenceDiagram
  participant Page as Page Component
  participant SD as StructuredData
  participant Builder as Graph Builder
  participant DOM as DOM

  Page->>SD: Render with { baseUrl?, logoUrl?, page, elements[] }
  SD->>Builder: Build graph (Organization, WebSite, WebPage)
  Builder->>Builder: Add elements (Article/Documentation/FAQ/SoftwareOffers)
  Builder->>Builder: Resolve URLs, dates (ISO), images, breadcrumbs
  Builder-->>SD: JSON-LD graph
  SD->>DOM: Inject single <script id="structured-data-page">
Loading
sequenceDiagram
  participant User as User
  participant Trigger as CollapsibleTrigger(asChild)
  participant Comp as Row Component
  participant Parent as onToggle handler

  User->>Trigger: Click header/div
  Trigger->>Comp: onOpenChange(open)
  Comp->>Parent: onToggle(id)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b31610b and 2b01612.

📒 Files selected for processing (13)
  • apps/dashboard/app/(main)/websites/[id]/profiles/_components/profile-row.tsx (4 hunks)
  • apps/dashboard/app/(main)/websites/[id]/sessions/_components/session-row.tsx (5 hunks)
  • apps/docs/app/(home)/page.tsx (2 hunks)
  • apps/docs/app/(home)/pricing/layout.tsx (1 hunks)
  • apps/docs/app/(home)/privacy/page.tsx (1 hunks)
  • apps/docs/app/(home)/terms/page.tsx (1 hunks)
  • apps/docs/app/blog/[[...slug]]/page.tsx (1 hunks)
  • apps/docs/app/docs/[[...slug]]/page.tsx (1 hunks)
  • apps/docs/app/layout.tsx (3 hunks)
  • apps/docs/components/landing/logo-carousel.tsx (1 hunks)
  • apps/docs/components/logo.tsx (2 hunks)
  • apps/docs/components/structured-data.tsx (1 hunks)
  • apps/docs/components/ui/kibo-ui/marquee/index.tsx (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @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.

@vachmara

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Aug 11, 2025

Copy link
Copy Markdown
Contributor
✅ Actions performed

Full review triggered.

@izadoesdev
izadoesdev merged commit 7ec0b46 into databuddy-analytics:staging Aug 11, 2025
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants