Skip to content

docs: update README with new features and architecture details#47

Merged
suradet-ps merged 3 commits into
suradet-ps:mainfrom
vate-ps:docs-update
Jun 2, 2026
Merged

docs: update README with new features and architecture details#47
suradet-ps merged 3 commits into
suradet-ps:mainfrom
vate-ps:docs-update

Conversation

@vate-ps
Copy link
Copy Markdown
Contributor

@vate-ps vate-ps commented Jun 2, 2026

Summary by Sourcery

Update README to reflect new TB Plus features and refreshed technology stack versions.

Documentation:

  • Document new weight-based dosage management and epidemiological mapping features in the README.
  • Refresh README technology badges and architecture section to match current framework and library major versions.

Summary by CodeRabbit

  • Documentation
    • Updated technology and version badges for the project stack
    • Revised product description
    • Added Weight-Based Dosage Management and Epidemiological Mapping to features list
    • Updated architecture documentation with toolchain details

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 2, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README to reflect the new cover-related capabilities and current tech stack versions, including new feature descriptions and aligned architecture details.

File-Level Changes

Change Details Files
Refresh technology badges to use major-version ranges and align them with the current stack.
  • Updated Tauri badge to show major version range instead of pinned patch version.
  • Updated Vue, TypeScript, Vite, Pinia, Vue Router, and Lucide badges to use simplified major or minor version ranges.
  • Adjusted Lucide badge labeling to match current package naming.
README.md
Update product description to be more general and not tied to a specific hospital.
  • Removed mention of Sabot Hospital in the main app description while keeping the HOSxP and SQLite integration details.
  • Kept focus on TB clinic operations and database-bridging behavior.
README.md
Document new cover-related clinical features and align the feature list with the current app capabilities.
  • Added a feature bullet for weight-based dosage management with automated calculations and alerts.
  • Added a feature bullet for epidemiological mapping with geographic visualization and clustering support.
README.md
Align architecture section with updated library versions and packages.
  • Updated frontend description to TypeScript 6, Vue Router 5, and lucide/vue.
  • Simplified backend Tauri version to major version 2 while keeping Rust and sqlx unchanged.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

Warning

Review limit reached

@vate-ps, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 53 minutes and 30 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 21c74ef1-40c7-4f3b-849e-5159d6ca3322

📥 Commits

Reviewing files that changed from the base of the PR and between e058036 and 3d69fc8.

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

Walkthrough

README.md updated with revised technology badges (Tauri, Vue, TypeScript, Vite, Pinia, Vue Router, Lucide), product description removing hospital-specific context, expanded features list including weight-based dosage management and epidemiological mapping, and updated architecture section reflecting current toolchain versions.

Changes

Project Documentation Refresh

Layer / File(s) Summary
Project overview and features documentation
README.md
Technology badges updated with current versions; introductory description revised to remove hospital-specific context; features list expanded with weight-based dosage management and epidemiological mapping; architecture section updated with current toolchain details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README refreshed, so shiny and new,
With badges that sparkle in every hue,
Features expanded for all who we serve,
The project's true purpose now plainly observed! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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.
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.
Title check ✅ Passed The title accurately describes the main change: updating README with new features and architecture details, which aligns with the documentation-only modifications made to the file.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • The dependency versions in the badges and Architecture section (e.g., TypeScript 6, Vue Router 5, Tauri 2) should be double-checked to match the actual versions in package.json/tauri config to avoid confusing readers.
  • The Tauri badge color code changed from 24c8db to 4c8db, which is not a valid 6-digit hex value; consider correcting this so the shield renders with the intended color.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The dependency versions in the badges and Architecture section (e.g., TypeScript 6, Vue Router 5, Tauri 2) should be double-checked to match the actual versions in package.json/tauri config to avoid confusing readers.
- The Tauri badge color code changed from `24c8db` to `4c8db`, which is not a valid 6-digit hex value; consider correcting this so the shield renders with the intended color.

## Individual Comments

### Comment 1
<location path="README.md" line_range="3" />
<code_context>
-[![Pinia](https://img.shields.io/badge/Pinia-%5E3.0.4-FFE16B?logo=vue.js&logoColor=black)](https://pinia.vuejs.org/)
-[![Vue_Router](https://img.shields.io/badge/Vue_Router-%5E5.0.4-4FC08D?logo=vuedotjs&logoColor=ffffff)](https://router.vuejs.org/)
-[![Lucide](https://img.shields.io/badge/Lucide-%5E1.0.0-F92672?logo=lucide&logoColor=ffffff)](https://lucide.dev/)
+[![Tauri](https://img.shields.io/badge/Tauri-%5E2-4c8db?logo=tauri&logoColor=fff)](https://tauri.app/)
+[![Vue.js](https://img.shields.io/badge/Vue.js-%5E3.5-4FC08D?logo=vuedotjs&logoColor=fff)](https://vuejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-%5E6-3178C6?logo=typescript&logoColor=ffffff)](https://www.typescriptlang.org/)
</code_context>
<issue_to_address>
**issue (typo):** The Tauri badge color code `4c8db` appears to be a typo (5-character hex) compared to the previous valid `24c8db`.

Please change this to a valid 6-character hex code (for example, restore `24c8db`) so the badge renders correctly.

```suggestion
[![Tauri](https://img.shields.io/badge/Tauri-%5E2-24c8db?logo=tauri&logoColor=fff)](https://tauri.app/)
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 3-9: The README currently references the wrong icon package name
'lucide/vue'; change any occurrence of 'lucide/vue' to the correct package name
'`@lucide/vue`' so it matches package.json (^1.17.0). Update the README
installation snippet or package mention and any related badge/alt text that
shows 'Lucide' to reflect '`@lucide/vue`' consistently (look for the string
'lucide/vue' and replace with '`@lucide/vue`').
🪄 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

Run ID: ca449416-1b1e-48dc-b868-d15c491ba101

📥 Commits

Reviewing files that changed from the base of the PR and between 732c466 and e058036.

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

Comment thread README.md Outdated
@vate-ps vate-ps changed the title docs: update README.md for cover feature docs: update README with new features and architecture details Jun 2, 2026
@suradet-ps suradet-ps merged commit 29da8c5 into suradet-ps:main Jun 2, 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.

2 participants