Skip to content

Conversation

@aralyekta
Copy link
Collaborator

@aralyekta aralyekta commented Nov 17, 2025

Add new analytics docs

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Analytics dashboard guide covering usage metrics, data insights, and reporting features.
    • Updated navigation links to point to the new Analytics guide.
    • Reorganized documentation structure for improved discoverability.

@coderabbitai
Copy link

coderabbitai bot commented Nov 17, 2025

Walkthrough

A documentation refactor replaces the "analyze-usage" guide with a new "analytics" guide. The old guide file is deleted, a new analytics guide is added with expanded dashboard documentation, and all internal navigation links are updated across multiple files and the site configuration to point to the new guide path.

Changes

Cohort / File(s) Change Summary
Content Replacement
guides/analytics.mdx, guides/analyze-usage.mdx
New analytics guide added with comprehensive dashboard documentation covering 12+ sections including Questions, User Distribution, Sentiment Analysis, and more. Old analyze-usage guide removed entirely.
Navigation Link Updates
guides/audit-logs.mdx, guides/create-guru.mdx, mint.json
Updated three guide references from /guides/analyze-usage to /guides/analytics in card hrefs and site navigation configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Verify all internal link references to the old guide have been updated (check for any missed references in undisplayed files)
  • Confirm the new analytics guide content is complete and properly formatted
  • Ensure mint.json navigation entry follows the correct structure

Possibly related PRs

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update analytics docs' is vague and generic, using non-descriptive terms that don't convey specific meaningful information about what changed. Consider a more specific title like 'Migrate analytics guide to new location' or 'Replace analyze-usage guide with new analytics dashboard guide' to clarify the scope and nature of the changes.
✅ 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.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef30e0c and 31e7243.

⛔ Files ignored due to path filters (19)
  • images/guides/analytics/analytics-tab.png is excluded by !**/*.png
  • images/guides/analytics/avg-trust-score-over-time.png is excluded by !**/*.png
  • images/guides/analytics/binge-len-stats.png is excluded by !**/*.png
  • images/guides/analytics/country-dist.png is excluded by !**/*.png
  • images/guides/analytics/custom-date.png is excluded by !**/*.png
  • images/guides/analytics/filters.png is excluded by !**/*.png
  • images/guides/analytics/intent-dist.png is excluded by !**/*.png
  • images/guides/analytics/questions-1.png is excluded by !**/*.png
  • images/guides/analytics/questions-2.png is excluded by !**/*.png
  • images/guides/analytics/referenced-source-questions.png is excluded by !**/*.png
  • images/guides/analytics/referenced-sources.png is excluded by !**/*.png
  • images/guides/analytics/sentiment-dist.png is excluded by !**/*.png
  • images/guides/analytics/sources-dist.png is excluded by !**/*.png
  • images/guides/analytics/stat-cards.png is excluded by !**/*.png
  • images/guides/analytics/topic-dist.png is excluded by !**/*.png
  • images/guides/analytics/unable-1.png is excluded by !**/*.png
  • images/guides/analytics/unable-2.png is excluded by !**/*.png
  • images/guides/analytics/user-dist.png is excluded by !**/*.png
  • images/guides/analytics/vote-stats.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • guides/analytics.mdx (1 hunks)
  • guides/analyze-usage.mdx (0 hunks)
  • guides/audit-logs.mdx (1 hunks)
  • guides/create-guru.mdx (1 hunks)
  • mint.json (1 hunks)
💤 Files with no reviewable changes (1)
  • guides/analyze-usage.mdx
🧰 Additional context used
📓 Path-based instructions (2)
**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.mdx: Use MDX format for all documentation files
Use Mintlify components like , , for rich content
Include practical examples and code snippets in documentation
Use images from /images/ directory for visual guides

Files:

  • guides/create-guru.mdx
  • guides/analytics.mdx
  • guides/audit-logs.mdx
mint.json

📄 CodeRabbit inference engine (CLAUDE.md)

mint.json: Navigation structure is defined in mint.json under the navigation key
mint.json contains all site configuration, navigation, and settings

Files:

  • mint.json
🧠 Learnings (1)
📚 Learning: 2025-07-19T21:27:14.098Z
Learnt from: CR
Repo: Gurubase/gurubase-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T21:27:14.098Z
Learning: Applies to {guides/integrations/**/*.mdx,integrations/**/*.mdx} : Maintain consistent structure across similar pages (e.g., all integration guides follow the same format)

Applied to files:

  • guides/analytics.mdx
🔇 Additional comments (5)
mint.json (1)

56-56: Navigation reference updated correctly.

The entry has been properly updated to point to the new analytics guide path. This aligns with the refactored documentation structure.

guides/create-guru.mdx (1)

154-154: Card link updated to new analytics guide path.

The "Analyze Usage Patterns" card href has been correctly updated to reference the new guides/analytics destination. The card description remains appropriately aligned with the new guide's content.

guides/analytics.mdx (2)

1-50: Comprehensive new analytics guide is well-structured and properly formatted.

The new guides/analytics.mdx file uses correct MDX syntax, proper Mintlify components (Frame, CardGroup, Card), and follows the documentation structure. Content is well-organized with clear sections covering dashboard access, key metrics, and all 12 dashboard sections with practical descriptions and visual guides.


255-284: CardGroup link targets are valid—all referenced files exist and will route correctly.

All four href paths in the CardGroup reference existing .mdx files (verified: api-reference/introduction.mdx, integrations/bots/discord.mdx, integrations/bots/github.mdx, integrations/bots/website-widget.mdx). The paths are correctly formatted for Mintlify routing. While these pages are not listed in mint.json navigation (making them sidebar-hidden), Mintlify still routes to them when accessed via direct links or href props, so the CardGroup will function correctly.

guides/audit-logs.mdx (1)

186-186: Card link updated to new analytics guide path.

The "Analytics Guide" card href has been correctly updated to reference the new guides/analytics destination. The card description accurately reflects the new guide's focus on usage pattern analysis.

Tip

📝 Customizable high-level summaries are now available!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  - Provide custom instructions to shape the summary (bullet lists, tables, contributor stats, etc.).
  - Use `high_level_summary_in_walkthrough` to move the summary from the description to the walkthrough section.

  Example:

  > "Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

  Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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

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.

3 participants