update documentation

This commit is contained in:
root
2026-05-26 19:28:44 -04:00
parent 9ab73e8ce6
commit 1a1c418087
46 changed files with 2292 additions and 8089 deletions
+29 -45
View File
@@ -1,57 +1,41 @@
## Project Design Audit
# Documentation Audit
Date: 2026-05-01
Date: 2026-05-26
### What I checked
## Purpose
- Compared `project_design` team-related source stubs against the live implementation in:
- `apps/dashboard/src/components/team/*`
- `apps/dashboard/src/app/(dashboard)/dashboard/team/page.tsx`
- `apps/api/src/routes/team.ts`
- `apps/api/src/routes/webhooks.ts`
- `apps/api/src/services/teamService.ts`
- `apps/api/src/middleware/requireRole.ts`
- Scanned the repo for obvious page- and feature-level gaps against:
- `project_design/README.md`
- `project_design/FEATURES.md`
- `project_design/PAGES.md`
- `project_design/advanced-features.md`
This note records the cleanup applied to the `docs/project-design` folder after comparing it with the live codebase.
### Added to the project
## Drift That Was Removed
- Copied the design documentation into `docs/project-design/`
- Copied the design source stubs into `docs/project-design/stubs/`
- Copied `project_design/rentalcardrive.png` into `apps/public-site/public/rentalcardrive.png`
The older design docs included several features or assumptions that are not active in the current implementation:
### Confirmed as already implemented in the app code
- Clerk-based employee auth and webhooks
- Clerk-based team invite acceptance
- renter self-service signup/login as an active user flow
- renter email verification as an active flow
- a separate white-label company public-site frontend app
- multi-currency SaaS subscription checkout beyond `MAD`
- marketing routes such as `/about`, `/contact`, and `/blog`
- outdated API file paths under `apps/api/src/routes/*`
- Team API route exists: `apps/api/src/routes/team.ts`
- Clerk invitation webhook route exists: `apps/api/src/routes/webhooks.ts`
- Team service exists: `apps/api/src/services/teamService.ts`
- Role middleware exists: `apps/api/src/middleware/requireRole.ts`
- Dashboard team UI exists:
- `apps/dashboard/src/app/(dashboard)/dashboard/team/page.tsx`
- `apps/dashboard/src/components/team/InviteModal.tsx`
- `apps/dashboard/src/components/team/EditMemberModal.tsx`
- `apps/dashboard/src/components/team/PermissionsMatrix.tsx`
- `apps/dashboard/src/hooks/useTeam.ts`
## Current Documentation Rule
These are not exact copies of the `project_design` stubs, but they cover the same implementation area and appear to be the working versions.
The `docs/project-design` files should describe only one of two things:
### Obvious gaps against the design docs
1. current implemented behavior
2. explicit future plans, clearly labeled as plans
- Public-site pages from the page spec are missing or not present as app routes:
- `/pricing`
- `/about`
- `/blog`
- Renter account routes described in the page spec are not present as standalone routes:
- `/renter/notifications`
- `/renter/saved-companies`
- `/renter/profile`
- The marketplace renter dashboard exists, but it is not split into the separate pages described in `project_design/PAGES.md`.
- The design document should not be treated as "fully implemented" yet. There are implemented areas, but the repo still has page-level and spec-level gaps.
They should not describe removed systems as if they are still live.
### Notes
## Current References
- The git worktree already had many unrelated local changes before this audit. I did not overwrite or revert them.
- This audit is a practical coverage check, not a formal end-to-end verification of every feature in `project_design/FEATURES.md`.
Use these documents as the current implementation references:
- `api-routes.md`
- `schema.md`
- `FEATURES.md`
- `PAGES.md`
- `INTEGRATION.md`
Use the execution-plan documents only as future/planning material, not as evidence that a feature is already shipped.