Skip to content

Conversation

@sbansal1999
Copy link
Contributor

@sbansal1999 sbansal1999 commented Jan 2, 2026

Description

First level of indentation was getting removed earlier.

Before After
Screenshot 2026-01-03 at 12 12 09 AM Screenshot 2026-01-03 at 12 11 42 AM

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

@vercel
Copy link

vercel bot commented Jan 2, 2026

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

A member of the Team first needs to authorize it.

@sbansal1999 sbansal1999 changed the base branch from main to staging January 2, 2026 18:40
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 2, 2026

Walkthrough

Documentation formatting adjustments to code samples in the feature flags documentation. Indentation and line spacing are reformatted for consistency. No functional logic, control flow, or public API changes.

Changes

Cohort / File(s) Summary
Documentation formatting
apps/docs/content/docs/features/feature-flags.mdx
Code block indentation and line wrapping adjustments; no functional or logical changes

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title claims to 'Extract flags cache key generation' but the actual changes are purely formatting/indentation fixes to documentation with no code refactoring or cache key extraction logic. Update the title to accurately reflect the actual changes, such as 'docs: Fix indentation in feature flags documentation' to match the formatting corrections described in the PR objectives.
✅ 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.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdce1a3 and f34928f.

📒 Files selected for processing (1)
  • apps/docs/content/docs/features/feature-flags.mdx
🧰 Additional context used
📓 Path-based instructions (1)
!(**/pages/_document.{ts,tsx,jsx})**/*.{ts,tsx,jsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

Don't import next/document outside of pages/_document.jsx in Next.js projects.

Files:

  • apps/docs/content/docs/features/feature-flags.mdx
🧠 Learnings (1)
📚 Learning: 2025-12-25T14:32:46.935Z
Learnt from: CR
Repo: databuddy-analytics/Databuddy PR: 0
File: .cursor/rules/01-MUST-DO.mdc:0-0
Timestamp: 2025-12-25T14:32:46.935Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Use json.stringify() when adding debugging code

Applied to files:

  • apps/docs/content/docs/features/feature-flags.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Greptile Review
🔇 Additional comments (3)
apps/docs/content/docs/features/feature-flags.mdx (3)

1-567: Title and description mismatch — consider clarifying PR purpose.

The PR title states "refactor: Extract flags cache key generation," but the description and AI summary indicate this is purely a documentation formatting fix (indentation and line spacing). The code changes are cosmetic and affect only the documentation's visual presentation, not any functional code or new features.

Recommend either:

  1. Retitling the PR to match the actual changes (e.g., "docs: Fix feature flags documentation indentation")
  2. Or confirming whether functional cache-key refactoring changes are in other files not included in this review

22-562: Code samples are syntactically correct and consistently formatted.

All code examples throughout the documentation (Quick Start, Hooks API, Flag Types, Configuration, Advanced Context, Best Practices, and Migration sections) have proper syntax, correct TypeScript/JSX formatting, and consistent 2-space indentation. The reformatting addresses the indentation issue mentioned in the PR description and improves readability without altering the substance or correctness of the examples.


567-567: Verify external link availability.

The CTA link to https://app.databuddy.cc/login should be tested to ensure it remains active and accessible. Consider adding a periodic link validation step to your docs pipeline if not already in place.


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.

@greptile-apps
Copy link

greptile-apps bot commented Jan 2, 2026

Greptile Summary

Fixed indentation in feature flags documentation by adding 2 spaces to all code blocks. The first level of indentation was being removed during rendering, causing improper code formatting in the documentation.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • This is a pure documentation formatting fix that only adds whitespace indentation to code examples. No logic, functionality, or code behavior is changed - only the visual presentation of documentation examples is improved.
  • No files require special attention

Important Files Changed

Filename Overview
apps/docs/content/docs/features/feature-flags.mdx Fixed indentation in code blocks by adding 2 spaces to preserve proper formatting when rendered

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant MDX as feature-flags.mdx
    participant Parser as MDX Parser
    participant CodeBlock as CodeBlock Component
    participant Browser as Browser Render

    Dev->>MDX: Edit code block indentation
    Note over MDX: Add 2 spaces to template literals
    MDX->>Parser: Parse MDX file
    Parser->>CodeBlock: Pass code with preserved indentation
    CodeBlock->>Browser: Render formatted code
    Note over Browser: First level indentation now preserved
Loading

@izadoesdev izadoesdev merged commit 3733323 into databuddy-analytics:staging Jan 2, 2026
7 of 9 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