forgejo_admin/basketball-api
1
0
Fork 1
Code Issues 10 Pull requests 3 Projects Releases Packages Wiki Activity Actions

docs: rewrite README as portfolio-facing project overview #228

Merged
forgejo_admin merged 1 commit from 226-readme-portfolio-rewrite into main 2026-03-28 22:22:32 +00:00
Conversation 0 Commits 1 Files changed 1 +36 -48
forgejo_admin commented 2026-03-28 22:15:18 +00:00
Owner
Copy link

Summary

Replaces the internal operational README with a polished, recruiter-ready project overview. Leads with impact metrics, covers the full tech stack and feature set, and links to the live Westside Kings & Queens frontend.

Changes

  • README.md — Complete rewrite. Removed internal links (Marcus quick links, Stripe test coupons, K8s setup prerequisites, raw endpoint table). Replaced with portfolio-grade content: impact banner (632 tests, 27 migrations, 17 route modules), stack summary, feature descriptions, architecture diagram, and streamlined dev setup.

Test Plan

  • Docs-only change — no code modified
  • Verified tests pass on main (632 collected)
  • README is 60 lines, within the requested limit
  • Visual review: README renders correctly in Forgejo markdown preview

Review Checklist

  • Passed automated review-fix loop
  • No secrets committed
  • No unnecessary file changes
  • Commit messages are descriptive

Related Notes

  • Closes #226
  • basketball-api — the project this work belongs to
## Summary Replaces the internal operational README with a polished, recruiter-ready project overview. Leads with impact metrics, covers the full tech stack and feature set, and links to the live Westside Kings & Queens frontend. ## Changes - `README.md` — Complete rewrite. Removed internal links (Marcus quick links, Stripe test coupons, K8s setup prerequisites, raw endpoint table). Replaced with portfolio-grade content: impact banner (632 tests, 27 migrations, 17 route modules), stack summary, feature descriptions, architecture diagram, and streamlined dev setup. ## Test Plan - [x] Docs-only change — no code modified - [x] Verified tests pass on main (632 collected) - [x] README is 60 lines, within the requested limit - [ ] Visual review: README renders correctly in Forgejo markdown preview ## Review Checklist - [x] Passed automated review-fix loop - [x] No secrets committed - [x] No unnecessary file changes - [x] Commit messages are descriptive ## Related Notes - Closes #226 - `basketball-api` — the project this work belongs to
docs: rewrite README as portfolio-facing project overview
All checks were successful
ci/woodpecker/pr/woodpecker Pipeline was successful
Details
f01de5cd72 
Replaces internal operational README with a polished, recruiter-ready
overview. Leads with impact metrics (632 tests, 27 migrations), covers
the full stack and feature set, and links to the live frontend.

Closes #226

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
forgejo_admin deleted branch 226-readme-portfolio-rewrite 2026-03-28 22:22:32 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
domain:backend

   
domain:devops

   
domain:frontend

   
status:approved

QA passed, awaiting merge approval

  
status:in-progress

Dev agent is actively working

  
status:needs-fix

QA found issues, back to dev

  
status:qa

PR submitted, awaiting QA review

  
type:bug

Bug fix

  
type:devops

Infrastructure/CI/config work

  
type:feature

New functionality

No labels
domain:backend
domain:devops
domain:frontend
status:approved
status:in-progress
status:needs-fix
status:qa
type:bug
type:devops
type:feature
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
forgejo_admin/basketball-api!228
No description provided.