feat: update docs for token efficient usage
Some checks failed
Deploy to Staging / Build Images (push) Has started running
Deploy to Staging / Deploy to Staging (push) Has been cancelled
Deploy to Staging / Verify Staging (push) Has been cancelled
Deploy to Staging / Notify Staging Ready (push) Has been cancelled
Deploy to Staging / Notify Staging Failure (push) Has been cancelled

This commit is contained in:
Eric Gullickson
2026-01-03 11:59:47 -06:00
parent 3dd86c37ff
commit b933329539
19 changed files with 333 additions and 71 deletions

20
frontend/src/CLAUDE.md Normal file
View File

@@ -0,0 +1,20 @@
# frontend/src/
## Files
| File | What | When to read |
| ---- | ---- | ------------ |
| `App.tsx` | Root component with routing | Route configuration, layout structure |
| `main.tsx` | Application entry point | Provider setup, initialization |
| `index.css` | Global styles | Base styling, CSS imports |
| `vite-env.d.ts` | Vite type definitions | TypeScript environment types |
## Subdirectories
| Directory | What | When to read |
| --------- | ---- | ------------ |
| `features/` | Feature modules (pages, components, hooks) | Feature development |
| `core/` | Shared infrastructure (auth, api, store) | Cross-cutting concerns |
| `components/` | Root-level shared components | App-wide UI components |
| `pages/` | Page-level components | Page structure, routing targets |
| `shared-minimal/` | Minimal shared UI (skeletons, theme) | Reusable UI primitives |

View File

@@ -0,0 +1,17 @@
# frontend/src/core/
## Subdirectories
| Directory | What | When to read |
| --------- | ---- | ------------ |
| `api/` | API client and request handling | HTTP calls, error handling |
| `auth/` | Auth0 provider and auth hooks | Authentication setup, user context |
| `config/` | Runtime configuration | Environment-specific settings |
| `debug/` | Debug utilities | Development helpers |
| `error-boundaries/` | React error boundaries | Error handling UI |
| `hooks/` | Shared React hooks | Reusable hook patterns |
| `query/` | React Query configuration | Server state management |
| `store/` | Zustand state management | Client state, global stores |
| `sync/` | Data synchronization | Offline support, sync logic |
| `units/` | Unit conversion utilities | Measurement formatting |
| `utils/` | General utilities | Helper functions |

View File

@@ -0,0 +1,19 @@
# frontend/src/features/
Feature module directory. Each feature contains pages/, components/, hooks/, api/, types/.
## Subdirectories
| Directory | What | When to read |
| --------- | ---- | ------------ |
| `admin/` | Admin panel and catalog management | Admin UI, user management |
| `auth/` | Authentication pages and components | Login, logout, auth flows |
| `dashboard/` | Dashboard and fleet overview | Home page, summary widgets |
| `documents/` | Document management UI | File upload, document viewer |
| `fuel-logs/` | Fuel log tracking UI | Fuel entry forms, statistics |
| `maintenance/` | Maintenance record UI | Service tracking, reminders |
| `notifications/` | Notification display | Alert UI, notification center |
| `onboarding/` | Onboarding wizard | First-time user experience |
| `settings/` | User settings pages | Preferences, account settings |
| `stations/` | Gas station finder UI | Station search, favorites, map |
| `vehicles/` | Vehicle management UI | Vehicle list, details, forms |