docs: consolidate repository guides and preserve audit history
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
# Frontend and UI
|
||||
|
||||
The UI is a client-rendered React application packaged by Next.js and served as static files through nginx. The primary application shell is in `job-tracker-ui/src/App.tsx`; feature views and components are under `src/views` and `src/components`.
|
||||
|
||||
## Topics
|
||||
|
||||
- [UI system](ui-system.md): theme, reusable MUI patterns, forms, dialogs, notifications, and responsive behavior.
|
||||
- [Navigation](navigation.md): public/authenticated routes and shell ownership.
|
||||
- [Localisation and accessibility](localisation-accessibility.md): English/Norwegian support, keyboard behavior, and verification limits.
|
||||
|
||||
The current UI redesign work-in-progress remains under [`../redesign/`](../redesign/). Those phase records are implementation evidence, not a replacement for this current-system guide.
|
||||
|
||||
The checked-in frontend entry point and capture extension have their own setup notes: [frontend README](../../job-tracker-ui/README.md) and [browser extension README](../../browser-extension/README.md).
|
||||
@@ -0,0 +1,5 @@
|
||||
# Localisation and accessibility
|
||||
|
||||
The UI ships English and Norwegian Bokmål translations through `job-tracker-ui/src/i18n/translations.ts`; language preference is persisted with the user settings model. New user-visible strings should be added to both locales and should not encode status meaning only in English text.
|
||||
|
||||
Accessible names, descriptions, loaded-state announcements, keyboard focus, modal return focus, contrast, and narrow-screen behavior are covered by unit/browser checks where practical. The full keyboard/screen-reader/zoom review for the CV builder and production export remains a manual gate; see [known issues](../roadmap/known-issues.md).
|
||||
@@ -0,0 +1,5 @@
|
||||
# Navigation
|
||||
|
||||
Public routes include `/`, `/login`, `/forgot-password`, `/reset-password`, and `/verify-email`. Authenticated routes include `/dashboard`, `/jobs`, `/reminders`, `/kanban`, `/companies`, `/correspondence`, `/correspondence/review`, `/profile`, `/career`, `/trash`, `/settings`, `/settings/connected-accounts`, and admin audit/users/system views.
|
||||
|
||||
The `/profile` surface owns account identity and security preferences. `/career` owns the master career profile and is the source for CV and other career outputs. The application shell and route definitions are in `job-tracker-ui/src/App.tsx`.
|
||||
@@ -0,0 +1,5 @@
|
||||
# UI system
|
||||
|
||||
MUI 7 components and the shared theme in `job-tracker-ui/src/theme.ts` define the visual foundation. Light and dark modes are user preferences; status colors communicate pipeline meaning and must not be used as the only signal. Forms, dialogs, loading states, errors, attachments, CV editing, job workspaces, and admin settings are implemented as feature components rather than a separate design-system package.
|
||||
|
||||
The UI supports responsive layouts for desktop and narrow screens, but route-specific overflow and keyboard/focus behavior still require the manual checks listed in [known issues](../roadmap/known-issues.md). Keep edits additive and preserve unsaved drafts, dialog return focus, and existing translated labels.
|
||||
Reference in New Issue
Block a user