Skip to content

docs(readme): add dashboard video preview#166

Merged
SantiagoDePolonia merged 5 commits into
mainfrom
docs/readme-dashboard-video
Mar 23, 2026
Merged

docs(readme): add dashboard video preview#166
SantiagoDePolonia merged 5 commits into
mainfrom
docs/readme-dashboard-video

Conversation

@SantiagoDePolonia

@SantiagoDePolonia SantiagoDePolonia commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add the dashboard demo video to docs/
  • embed the dashboard preview near the top of the README
  • keep the badges at the top of the README

Testing

  • pre-commit checks on staged files during git commit
  • no additional tests run (docs-only change)

Summary by CodeRabbit

  • Documentation
    • Added an animated dashboard demo to the README illustrating usage analytics, token tracking, and estimated cost monitoring.
    • The demo is embedded near the introduction to give a quick visual walkthrough of key monitoring metrics and flows, helping users understand dashboard insights without changing app functionality.

@coderabbitai

coderabbitai Bot commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1513b546-2664-414b-aaca-da2cc0a7336f

📥 Commits

Reviewing files that changed from the base of the PR and between 0812b0a and ff0d384.

⛔ Files ignored due to path filters (1)
  • docs/dashboard.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Embeds an animated dashboard GIF into README.md using an HTML-wrapped image link to docs/dashboard.gif (with alt text describing usage analytics, token tracking, and estimated cost monitoring), placed before the "Quick Start - Deploy the AI Gateway" section.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added an HTML-wrapped image link referencing docs/dashboard.gif to display an animated dashboard demo (usage analytics, token tracking, estimated cost monitoring) under the introductory description and before the "Quick Start - Deploy the AI Gateway" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped into README with a GIF so bright,
A dashboard that twinkles in morning light,
Tokens and metrics take a joyful spin,
Costs and insights hop — let the review begin! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(readme): add dashboard video preview' accurately describes the main change - adding a dashboard preview to the README documentation.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-dashboard-video

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.

@SantiagoDePolonia SantiagoDePolonia merged commit 2715476 into main Mar 23, 2026
12 of 13 checks passed
@SantiagoDePolonia SantiagoDePolonia deleted the docs/readme-dashboard-video branch April 4, 2026 11:52
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.

1 participant