docs: update architecture documentation and manifests

Refine technical documentation to reflect current architecture, component structure, and routing conventions for the vcon console.
This commit is contained in:
Team Dark Devil committed 2026-11-17 21:22:55 +06:00
1 parent bb938c33c0
commit 367dd819f8
64 files changed
+910 -2661

No files matched your search

+9 -11
View File
@@ -1,15 +1,13 @@
# Layout Components Module Manifest
# Layout Components Manifest
## Purpose
Global layout shell, navigation, top bar, and admin sidebar complying with compact, zero-border-radius, zero-shadow design system.
Global layout shells, navigation headers, and sidebars shared across the public overview and `/vcon/*` administration console.
## Components
- **Navbar.tsx**: Top titlebar with brand, quick links, runtime port indicator (:4000/:3000), and dark/light theme switcher.
- **Sidebar.tsx**: Dedicated `/vcon/` admin console sidebar with mobile drawer support, grouped telemetry & management links.
- **Footer.tsx**: System runtime status line with storage convention display and port allocations.
- **MainLayout.tsx**: Viewport-bounded responsive shell with mobile backdrop and scrolling main container.
## Dependencies
- `components/ui`
- `next/link`
- `next/navigation`
- `MainLayout.tsx`: Responsive root shell pairing the top navigation bar, sidebar (for `/vcon/*` routes), and scrollable main content region.
- `Navbar.tsx`: Top navigation bar displaying the brand, quick links, dark/light theme toggle, and authenticated administrator controls.
- `Sidebar.tsx`: Collapsible `/vcon/*` administration navigation rail with mobile drawer support.
- `PageShell.tsx`: Standard page container used by all `/vcon/*` views, pairing `AdminPageHeader` with consistent vertical spacing.
- `AdminPageHeader.tsx`: Compact page header rendering the current route title and right-aligned action buttons.
- `SettingsPanel.tsx`: Two-column key/value configuration layout used by `/vcon/settings` and `/vcon/profile`.
- `Footer.tsx`: Compact status footer for public landing pages.
+12 -6
View File
@@ -1,9 +1,15 @@
# Sections Manifest
# Page Sections Manifest
## Purpose
Modular section blocks used in landing page and documentation views.
Modular feature sections used across the public landing page and `/vcon/*` administration views.
## Sections
- `Hero.tsx`: Headline, technical metrics, quick start buttons
- `Features.tsx`: Subsystem cards with icons and descriptions
- `Architecture.tsx`: Visual diagram of decoupled port 4000/3000 runtime and data flow.
## Components
- `Hero.tsx`: Public overview hero section with architecture highlights and quick navigation links.
- `Features.tsx`: Core platform capability cards (WebSocket ingestion, partitioned CSV storage, SDK management).
- `SdkSection.tsx`: Interactive Python SDK code preview on the landing page.
- `LandingAbout.tsx`: Deployment and storage architecture summary section.
- `AdminLogin.tsx`: Administrator sign-in form with theme switcher and session persistence toggle.
- `AdminSetup.tsx`: Initial administrator account creation form.
- `ClientsView.tsx`: Client management workspace with search, status filters, and registration modal.
- `ClientsTable.tsx`: Client registry table with credential display, key rotation, access revocation, and deletion modals.
- `ExportWorkspace.tsx`: CSV and JSON dataset export builder with client/date filtering and recent partition downloads.
+16 -15
View File
@@ -1,19 +1,20 @@
# UI Components Module Manifest
# UI Primitives Manifest
## Purpose
Unified, zero-pill, zero-shadow compact UI design system following the DataStack design guidelines.
Single-source-of-truth UI component library implementing DataStack's compact, zero-border-radius, zero-shadow design system.
## Components
- **Button.tsx**: Standardised buttons with size variants (default 32px, sm 27px, xs 24px, icon 30px), zero border-radius, outline focus.
- **Input.tsx**: Inputs, Textareas, and Selects with consistent border token and Segoe UI typography.
- **Card.tsx**: Structured data container surfaces with zero radius, 1px subtle borders, and header/content/footer partitions.
- **Modal.tsx**: Accessible dialogs with key listener (Escape), backdrop blur, and flexible action footers.
- **Table.tsx**: Compact fixed data tables for real-time streams, client listings, and export jobs.
- **Form.tsx**: Form wrappers, switch toggles, and multi-column row layouts.
- **Text.tsx**: Typography engine providing hierarchy (h1, h2, h3, body, muted, dim, label, code, badge).
- **Icon.tsx**: Lucide-react wrapper for icon rendering.
- **Toast.tsx**: Real-time notification and error/success/warning report system.
## Dependencies
- `lucide-react`
- `@/lib/utils` (clsx + tailwind-merge)
- `Button.tsx`: Action buttons with variants (`primary`, `secondary`, `ghost`, `danger`, `icon`) and sizes (`default`, `sm`, `xs`, `icon`).
- `Input.tsx`: Standardized `Input`, `Textarea`, and `Select` controls with compact mode and right-element slots.
- `Card.tsx`: Structured 1px-bordered surface containers (`Card`, `CardHeader`, `CardTitle`, `CardContent`, `CardFooter`).
- `Panel.tsx`: Titled section container with optional metadata badge and header action slot.
- `StatStrip.tsx`: Responsive 4-column metric strip used at the top of `/vcon/*` views.
- `Table.tsx`: Compact tabular data primitives (`TableWrap`, `Table`, `TableHeader`, `TableBody`, `TableRow`, `TableHead`, `TableCell`, `TableEmpty`).
- `Modal.tsx`: Accessible modal dialog with Escape key handling and action footer.
- `Form.tsx`: Form layout wrappers and `FormSwitch` boolean toggle control.
- `Pill.tsx`: Compact filter pill button for status and date-range selection.
- `CodeBlock.tsx`: Monospace syntax block for displaying SDK snippets and JSON payloads.
- `CopyButton.tsx`: Clipboard copy button with visual confirmation state.
- `Text.tsx`: Typography helper component for headings, labels, and inline code.
- `Icon.tsx`: Dynamic Lucide icon renderer.
- `Toast.tsx`: Toast notification provider (`useToast`) for operation feedback.