Skip to content

docs(docs): add tech-stack badges to README (shields.io for-the-badge) (#273)#274

Merged
w7-mgfcode merged 1 commit into
devfrom
docs/readme-tech-stack-badges
May 20, 2026
Merged

docs(docs): add tech-stack badges to README (shields.io for-the-badge) (#273)#274
w7-mgfcode merged 1 commit into
devfrom
docs/readme-tech-stack-badges

Conversation

@w7-mgfcode
Copy link
Copy Markdown
Owner

Closes #273.

Summary

Adds a 31-badge block to the README between the tagline and the Features section, matching the user-provided HTML5 `for-the-badge` style. One status row + four tech-stack rows (Backend / Frontend / ML/AI / Tooling). No new files, no new assets — every badge resolves through shields.io.

Layout

  • Status (4): `License: MIT` · `Release` (dynamic from GitHub releases) · `CI` (dynamic from `ci.yml` on `dev`) · `Python 3.12+`
  • Backend (7): FastAPI · Pydantic v2 · SQLAlchemy 2.0 · PostgreSQL 16 · pgvector · Alembic · structlog
  • Frontend (6): React 19 · TypeScript · Vite 7 · Tailwind 4 · shadcn/ui · TanStack Query
  • ML / AI (7): scikit-learn · LightGBM · XGBoost · PydanticAI · OpenAI · Anthropic · Ollama
  • Tooling (7): Docker · uv · pnpm · GitHub Actions · Ruff · mypy --strict · pytest

Validation

  • HEAD-probe: all 31 shields URLs return HTTP 200.
  • SVG logo verification: every badge that cites `&logo=` was checked for an `` element in the rendered SVG. All cited logos resolve (anthropic, astral, ruff, reactquery, ollama, shadcnui, pydantic, sqlalchemy, fastapi, postgresql, python, react, typescript, vite, tailwindcss, scikitlearn, openai, docker, pnpm, githubactions, pytest, github).
  • Text-only by design (no brand icon on shields.io): LightGBM, XGBoost, structlog, mypy --strict, Alembic — render as colored text badges in matching brand colors.

Why this PR doesn't risk drift

The Release + CI badges are dynamic — they read from this repo. They self-update with every release and CI run on `dev` without any further edits to the README.

Test plan

  • All 31 `https://img.shields.io/…\` URLs return 200 (HEAD probe)
  • All cited `&logo=…` parameters resolve to a rendered icon in the SVG body
  • Dynamic badges (Release, CI) point at this repo, not a placeholder
  • Single-commit PR; ready for squash or merge

#273)

Add 31 shields.io for-the-badge style badges to the README, grouped
into a 4-badge status row (License · Release · CI · Python) and four
tech-stack rows (Backend, Frontend, ML/AI, Tooling). Matches the
visual style of the user-provided HTML5 badge example.

All shields URLs HEAD-probed (200) and SVG-verified for logo
presence on every badge that cites one (FastAPI, Pydantic, SQLAlchemy,
PostgreSQL, React, TypeScript, Vite, Tailwind, shadcn/ui, TanStack
Query, scikit-learn, PydanticAI, OpenAI, Anthropic, Ollama, Docker,
uv, pnpm, GitHub Actions, Ruff, pytest, Python). LightGBM, XGBoost,
structlog, mypy, and Alembic render as text-only badges by design —
no canonical simple-icons brand entries exist for them.

Release + CI badges are dynamic: they read from this repo so they
self-update with each release and CI run on `dev` without further
edits.
Copy link
Copy Markdown

@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.

Sorry @w7-mgfcode, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2a38649c-559c-4d06-ad2b-c5a8e93bbfae

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-tech-stack-badges

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.

@w7-mgfcode w7-mgfcode merged commit c994842 into dev May 20, 2026
8 checks passed
@w7-mgfcode w7-mgfcode deleted the docs/readme-tech-stack-badges branch May 20, 2026 03:26
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