Skip to content

docs(readme): add credit module architecture diagram - #198

Merged
JLaborda merged 1 commit into
mainfrom
docs/readme-credit-architecture
Nov 4, 2026
Merged

JLaborda merged 1 commit into
mainfrom
docs/readme-credit-architecture

Conversation

@JLaborda

@JLaborda JLaborda commented Nov 4, 2026

Copy link
Copy Markdown
Owner

Summary

Adds the Credit CSS architecture diagram to the portfolio README so the shipped v0.2.0 demo slice is documented visually.

  • New asset: docs/images/smartwealthai-credit-architecture.png (byte-for-byte from the provided diagram; size 218728, sha256 06f64f9d33eccc95a1edf8433f33a53ecd4c6c1a901df1b0fa2b457a75067887)
  • Embeds the image in the Credit (shipped demo slice) section of README.md with descriptive English alt text and a caption stating it corresponds to portfolio v0.2.0 (commit 5e916033)
  • No model metrics (AUC/scores/performance) added; no other files touched

Please do not auto-merge — Jorge merges.

Commands run

Command Result
sha256sum + size check on attached PNG Match: 218728 bytes, 06f64f9d…067887
cmp source vs docs/images/…png Identical
make install OK (uv sync --frozen --group dev)
make lint OK (ruff check + format check)
make test 341 passed
Local README relative-link resolver 21/21 local links OK (incl. image path)
npx markdown-link-check README.md 23 links checked, all OK (incl. image + commit URL)

Files changed

  • docs/images/smartwealthai-credit-architecture.png (new)
  • README.md (+4 lines)
Open in Web Open in Cursor 

Embed the v0.2.0 credit CSS architecture PNG in the README credit
section so the shipped demo slice is visually documented.

Co-authored-by: Jorge D. Laborda <JLaborda@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Nov 4, 2026

Copy link
Copy Markdown

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters: 2
  • README.md is excluded by none and included by none
  • docs/images/smartwealthai-credit-architecture.png is excluded by !**/*.png, !**/*.{png,jpg,jpeg,gif,webp,pdf,joblib,pkl,parquet,feather,h5,hdf5} and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.73%. Comparing base (5e91603) to head (9e7d0a9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #198   +/-   ##
=======================================
  Coverage   98.73%   98.73%           
=======================================
  Files          40       40           
  Lines        2609     2609           
  Branches      312      312           
=======================================
  Hits         2576     2576           
  Misses         25       25           
  Partials        8        8           
Flag Coverage Δ
credit 100.00% <ø> (ø)
investing 97.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JLaborda
JLaborda merged commit a386bd7 into main Nov 4, 2026
6 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