Skip to content

Commit b9ae868

Browse files
authored
Revise README for kortex-mockups project
Updated project name and expanded README with directory structure and getting started guide.
1 parent 2cd7da6 commit b9ae868

1 file changed

Lines changed: 55 additions & 2 deletions

File tree

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# kortex-spec
2-
Repository for live mockups and specifications for development of Kortex
1+
# kortex-mockups
2+
3+
This repository is dedicated for live prototyping and UX explorations for Kortex.
4+
5+
6+
## 📁 Directory Structure
7+
8+
```
9+
kortex-mockups/
10+
├── index.html # Landing page with welcome screen
11+
├── README.md # Project documentation
12+
13+
├── assets/ # Shared resources
14+
│ ├── css/
15+
│ │ └── styles.css # Global stylesheet (all UI styles)
16+
│ ├── js/
17+
│ │ └── scripts.js # Shared JavaScript functions
18+
│ └── images/ # Shared images and icons
19+
20+
├── shared/ # Shared components
21+
│ └── components/
22+
│ └── sidebar.html # Reusable navigation sidebar (reference)
23+
24+
├── chat/ # Chat section
25+
│ └── index.html # Chat interface with AI conversations
26+
27+
├── knowledges/ # Knowledge bases section (RAG)
28+
│ ├── index.html # Knowledge bases list view
29+
│ └── details.html # Knowledge base details view
30+
31+
├── mcp/ # MCP servers section
32+
│ └── index.html # MCP servers interface (placeholder)
33+
34+
├── flows/ # Flows section
35+
│ └── index.html # Workflow orchestration (placeholder)
36+
37+
├── extensions/ # Extensions section
38+
│ └── index.html # Extensions marketplace (placeholder)
39+
40+
└── settings/ # Settings section
41+
└── index.html # Application settings (placeholder)
42+
```
43+
44+
## 🚀 Getting Started
45+
46+
1. Open `index.html` in a web browser to see the welcome screen
47+
2. Navigate to different sections using:
48+
- Sidebar navigation (consistent across all pages)
49+
- Welcome screen navigation cards
50+
3. Each section maintains:
51+
- Consistent left sidebar navigation
52+
- Active state highlighting (gray background + purple left border)
53+
- Hover states (purple background)
54+
- Shared styling from `assets/css/styles.css`
55+

0 commit comments

Comments
 (0)