Skip to content

docs: add README metrics table - #6

Merged
CoreyLeath-code merged 1 commit into
mainfrom
docs/add-readme-metrics-table
Jul 12, 2026
Merged

CoreyLeath-code merged 1 commit into
mainfrom
docs/add-readme-metrics-table

Conversation

@CoreyLeath-code

@CoreyLeath-code CoreyLeath-code commented Jul 12, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Adds a consolidated README metrics table for repository, test, CI/CD, dependency, delivery, model configuration, API, observability, SLO, and architecture benchmark metrics.
  • Records measured repo inventory from git ls-files and runtime/SLO values from checked-in configuration and docs.
  • Keeps existing architecture benchmark content intact while making the recommended metrics easier to scan.

Validation

  • pytest --basetemp=.pytest-tmp/run --cov=app --cov=recommender --cov-report=term-missing
    • 27 passed
    • 54% combined coverage across app and recommender
  • git diff --check

Notes

  • Installed missing local test dependencies (torch, pydantic-settings) to run the suite in the workspace venv.
  • Metrics were measured on 2026-07-12.

Summary by CodeRabbit

  • Documentation
    • Added a Metrics Table to the README covering repository, model configuration, API, observability, and service-level metrics.
    • Included benchmark measurement details and the date of collection.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md adds a “Metrics Table” section documenting repository counts, model configuration defaults, API routes, Prometheus metrics, and SLO/benchmark measurements recorded on 2026-07-12.

Changes

Metrics Documentation

Layer / File(s) Summary
Metrics table
README.md
Adds repository, model, API, observability, latency, availability, and benchmark metrics to the README.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a metrics table to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-readme-metrics-table

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

@CoreyLeath-code
CoreyLeath-code marked this pull request as ready for review July 12, 2026 22:21

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 65-67: Update the README performance table around the “Current /
Recommended Value” column to distinguish measured values, configuration
defaults, SLO targets, and architecture benchmarks. Add a value-type column or
separate the sections, and label entries such as “< 50 ms” and “~12,000
requests/sec” according to their documented source rather than presenting them
as measured current performance.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 71c3fa6f-456f-476d-9dba-446a3a7446db

📥 Commits

Reviewing files that changed from the base of the PR and between 4d43d26 and 488eb71.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +65 to +67
Measured from the repository on 2026-07-12. Runtime and SLO values are recorded from the checked-in configuration, metrics documentation, and README architecture notes.

| Area | Metric | Current / Recommended Value | Source |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Distinguish measured values, defaults, targets, and benchmarks.

The Current / Recommended Value column combines repository measurements, configuration defaults, SLO targets, and documented architecture benchmarks. Add a value-type column or split these sections so consumers do not mistake targets such as < 50 ms or documented claims such as ~12,000 requests/sec for independently measured current performance.

Also applies to: 96-104

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 65 - 67, Update the README performance table around
the “Current / Recommended Value” column to distinguish measured values,
configuration defaults, SLO targets, and architecture benchmarks. Add a
value-type column or separate the sections, and label entries such as “< 50 ms”
and “~12,000 requests/sec” according to their documented source rather than
presenting them as measured current performance.

@CoreyLeath-code
CoreyLeath-code merged commit 010fe22 into main Jul 12, 2026
7 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.

1 participant