docs: add AUTH, COMPONENTS_GUIDE, PRD, design, limitations docs + upd… - #9
Conversation
|
Warning Review limit reached
Next review available in: 56 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Free Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (6)
Note 🎁 Summarized by CodeRabbit FreeYour organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login. Comment |
There was a problem hiding this comment.
Pull request overview
This PR transitions the repository from a starter template README to AetherLive-specific documentation, adding product, auth, UI component, and limitations docs to support contributor onboarding and planning.
Changes:
- Replaced the root README with an AetherLive overview, architecture/auth notes, setup instructions, and known gaps.
- Added new product and technical documentation (PRD, auth architecture, component guide, limitations/weaknesses).
- Introduced additional design documentation scaffolding.
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces template README with project overview, architecture, setup, and known gaps. |
| doc/PRD.md | Adds a draft product requirements document and timeline/scope. |
| doc/LIMITATIONS_AND_WEAKNESSES.md | Documents current technical/product gaps and risks. |
| doc/design.md | Adds a design doc entry (currently empty). |
| doc/COMPONENTS_GUIDE.md | Adds a comprehensive UI component guide (currently far ahead of repo state). |
| doc/AUTH.md | Documents Clerk+Convex auth architecture, routes, and env vars. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Redirects unauthenticated users to Clerk sign-in | ||
| - Redirects authenticated users without an org to `/org-selection` | ||
|
|
||
| 2. **AuthGuard Component** (`modules/auth/ui/components/auth-guard.tsx`) |
| - Client-side guard in the dashboard layout | ||
| - Validates Convex session alongside Clerk | ||
|
|
||
| 3. **OrganizationGuard** (`modules/auth/ui/components/organization-guard.tsx`) |
|
|
||
| **Key features:** | ||
| - Clerk provider with Convex integration (`ConvexProviderWithClerk`) | ||
| - Resizable panel components from shared UI (`@workspace/ui/components/resizable-panels`) |
| Current components: | ||
| - `Button` — CVA variants (default, destructive, outline, secondary, ghost, link) + sizes | ||
| - `Input` — styled `<input>` with form integration | ||
| - `ResizablePanelGroup`, `ResizablePanel`, `ResizableHandle` — used in dashboard layout (exported from UI package) |
| **Key features:** | ||
| - Clerk provider with Convex integration (`ConvexProviderWithClerk`) | ||
| - Resizable panel components from shared UI (`@workspace/ui/components/resizable-panels`) | ||
| - Conversations layout (`modules/dashboard/layouts/conversations-layout.tsx`) — missing `ConversationsPanel` component |
| | 2 | `ConversationsPanel` component missing | `modules/dashboard/layouts/conversations-layout.tsx` | High | | ||
| | 3 | `dashboard/components/` and `dashboard/views/` are empty | `apps/web/modules/dashboard/` | High | |
| | 3 | No empty states for lists/tables | User sees blank pages with no guidance | | ||
| | 4 | No pagination or infinite scroll on conversation lists | `InfiniteScrollTrigger` exists but no data to paginate | | ||
| | 5 | `use-moblie.ts` filename typo | `apps/web/hooks/use-moblie.ts` | | ||
| | 6 | `ratio-group.tsx` filename typo | `packages/ui/src/components/ratio-group.tsx` | |
| | SignInView | `modules/auth/ui/views/sign-in-view.tsx` | `<SignIn routing="hash" />` | | ||
| | SignUpView | `modules/auth/ui/views/sign-up-view.tsx` | `<SignUp routing="hash" />` | | ||
| | OrgSelectionView | `modules/auth/ui/views/org-selection-view.tsx` | `<OrganizationList hidePersonal skipInvitationScreen />` | |
| # UI Components — Complete Guide | ||
|
|
||
| > **ALL files in `packages/ui/src/components/`** — shadcn/ui style wrappers around Radix, Recharts, and other libraries. | ||
|
|
|
|
||
| --- | ||
|
|
||
| ### `dicbear-avatar.tsx` |
…ate README