ldraney/westside-app
1
0
Fork 0
Code Issues 17 Pull requests Projects Releases Packages Wiki Activity Actions

docs: portfolio-facing README rewrite #158

Merged
forgejo_admin merged 1 commit from 157-readme-portfolio-polish into main 2026-03-28 22:13:30 +00:00
Conversation 1 Commits 1 Files changed 1 +58 -2
forgejo_admin commented 2026-03-28 22:09:29 +00:00
Contributor
Copy link

Summary

Replaces the one-line README stub with a polished, recruiter-facing project overview. Covers stack, features, project structure, dev setup, and links to related repos.

Changes

  • README.md — Complete rewrite (59 lines). Stack table, feature descriptions, route structure, dev commands, related repos.

Test Plan

  • Verify README renders correctly on Forgejo
  • Confirm all repo links resolve
  • Confirm live site link resolves

Review Checklist

  • Code follows project conventions
  • No secrets or credentials in diff
  • Changes scoped to issue

Related Notes

None.

Related

Closes #157

## Summary Replaces the one-line README stub with a polished, recruiter-facing project overview. Covers stack, features, project structure, dev setup, and links to related repos. ## Changes - `README.md` — Complete rewrite (59 lines). Stack table, feature descriptions, route structure, dev commands, related repos. ## Test Plan - [ ] Verify README renders correctly on Forgejo - [ ] Confirm all repo links resolve - [ ] Confirm live site link resolves ## Review Checklist - [x] Code follows project conventions - [x] No secrets or credentials in diff - [x] Changes scoped to issue ## Related Notes None. ## Related Closes #157
docs: rewrite README as portfolio-facing project overview
All checks were successful
ci/woodpecker/pr/woodpecker Pipeline was successful
Details
a18cecd973 
Replaces the one-line stub with a recruiter-ready README covering
stack, features, project structure, and related repos.

Closes #157

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
forgejo_admin commented 2026-03-28 22:10:01 +00:00
Author
Contributor
Copy link

QA Review -- PR #158

Scope: Docs-only. 1 file changed (README.md), 58 additions, 2 deletions. No code, no config, no secrets.

Checks

  • Accuracy -- Stack table matches codebase: adapter-static (verified svelte.config.js), nginx serving (verified Dockerfile), Keycloak auth present in routes.
  • Route structure -- (public)/ and (app)/ descriptions match actual route directories verified in src/routes/.
  • Feature coverage -- All listed features (registration, coach dashboards, admin CRM, contract e-signing, payment, Keycloak SSO) correspond to real routes in the codebase.
  • Line count -- 59 lines, within the 60-line constraint from the issue.
  • Title -- Correctly uses westside-landing (Forgejo repo name) rather than westside-app (local directory name).
  • No secrets -- No credentials, tokens, or sensitive data in diff.
  • Links -- Live site URL, basketball-api, westside-contracts, pal-e-platform all use correct Forgejo URLs.
  • Dev instructions -- Port 5174 matches package.json dev script. Environment variables (PUBLIC_API_URL, PUBLIC_KEYCLOAK_URL) are reasonable.

Nits

None.

VERDICT: APPROVED

## QA Review -- PR #158 **Scope:** Docs-only. 1 file changed (`README.md`), 58 additions, 2 deletions. No code, no config, no secrets. ### Checks - [x] **Accuracy** -- Stack table matches codebase: `adapter-static` (verified `svelte.config.js`), nginx serving (verified `Dockerfile`), Keycloak auth present in routes. - [x] **Route structure** -- `(public)/` and `(app)/` descriptions match actual route directories verified in `src/routes/`. - [x] **Feature coverage** -- All listed features (registration, coach dashboards, admin CRM, contract e-signing, payment, Keycloak SSO) correspond to real routes in the codebase. - [x] **Line count** -- 59 lines, within the 60-line constraint from the issue. - [x] **Title** -- Correctly uses `westside-landing` (Forgejo repo name) rather than `westside-app` (local directory name). - [x] **No secrets** -- No credentials, tokens, or sensitive data in diff. - [x] **Links** -- Live site URL, basketball-api, westside-contracts, pal-e-platform all use correct Forgejo URLs. - [x] **Dev instructions** -- Port 5174 matches `package.json` dev script. Environment variables (`PUBLIC_API_URL`, `PUBLIC_KEYCLOAK_URL`) are reasonable. ### Nits None. ### VERDICT: APPROVED
forgejo_admin deleted branch 157-readme-portfolio-polish 2026-03-28 22:13:30 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
domain:backend

   
domain:devops

   
domain:frontend
No labels
domain:backend
domain:devops
domain:frontend
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
ldraney/westside-app!158
No description provided.