Skip to content

docs: add metrics module to quickstart#200

Merged
Nek-12 merged 1 commit intomasterfrom
docs-metrics-module-quickstart
Jan 20, 2026
Merged

docs: add metrics module to quickstart#200
Nek-12 merged 1 commit intomasterfrom
docs-metrics-module-quickstart

Conversation

@Nek-12
Copy link
Copy Markdown
Member

@Nek-12 Nek-12 commented Jan 20, 2026

Adds the metrics artifact to the docs quickstart dependency snippets so it shows up alongside other core modules.

Summary by CodeRabbit

  • Chores
    • Added metrics collection and export module to the project build configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 20, 2026

📝 Walkthrough

Walkthrough

A new metrics module (flowmvi-metrics) is added to the project's version catalogs and Gradle dependencies. The addition demonstrates how to include metrics collection and export capabilities using the flowmvi framework across both TOML and Kotlin DSL dependency declaration formats.

Changes

Cohort / File(s) Summary
Metrics Module Documentation
docs/docs/quickstart.md
Adds flowmvi-metrics module dependency to version catalogs (TOML entry with module reference and version binding) and Gradle implementation blocks with inline comments explaining metrics collection & export functionality

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Poem

🐰 Metrics now hop into view,
Collection and export—shiny and new!
With Gradle and catalogs, all in a line,
Our flowmvi flows measure in perfect time!

🚥 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: add metrics module to quickstart' accurately and specifically describes the main change in the PR, which adds the metrics module to the quickstart 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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-metrics-module-quickstart

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.

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @Nek-12, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the project's quickstart documentation by integrating the flowmvi-metrics module. The update ensures that the metrics artifact is properly listed within the dependency snippets, providing users with comprehensive guidance on including this performance collection module alongside other core components.

Highlights

  • Documentation Update: The flowmvi-metrics module has been added to the quickstart documentation.
  • Dependency Snippets: The metrics artifact is now included in the dependency snippets, making it visible alongside other core modules.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the flowmvi-metrics dependency to the quickstart documentation, which is a great addition. The changes are correct and align with the goal of the PR. I have one minor suggestion to improve the clarity of the code snippet in the documentation to better guide users on the intended usage of the metrics module, similar to how the debugger dependency is handled.

commonMainImplementation("pro.respawn.flowmvi:compose:$flowmvi")
// saving and restoring state
commonMainImplementation("pro.respawn.flowmvi:savedstate:$flowmvi")
// metrics collection & export
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The metrics.md documentation recommends using metrics only on release builds. To provide better guidance to users in the quickstart and maintain consistency with how the debugger-plugin is documented as "(use on debug only)", it would be beneficial to add a similar explanatory note here.

Suggested change
// metrics collection & export
// metrics collection & export (recommended for release builds)

@Nek-12 Nek-12 merged commit 4615620 into master Jan 20, 2026
3 of 4 checks passed
@Nek-12 Nek-12 deleted the docs-metrics-module-quickstart branch January 20, 2026 09:25
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