Skip to content

Commit 6b39bb4

Browse files
author
sun
committed
Fix 404: add User Guide overview page
1 parent 74d0df6 commit 6b39bb4

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/userGuide/index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Compileo User Guides
2+
3+
Welcome to the Compileo User Guides. Compileo is a comprehensive suite for document processing and dataset engineering.
4+
5+
To get started, please select a topic from the navigation tabs above or the sidebar.
6+
7+
## Functional Modules
8+
9+
### 🚀 Getting Started
10+
Learn how to install, authenticate, and configure your Compileo instance.
11+
12+
### 📑 Document Processing
13+
Guides on ingesting various file types and using AI to split documents into semantic chunks.
14+
15+
### 🧠 Data Engineering
16+
Discover how to build taxonomies, perform entity extraction, and generate high-quality datasets.
17+
18+
### ⚙️ Job Management
19+
Monitor and manage your long-running data processing tasks.
20+
21+
### 🧪 Quality & Evaluation
22+
Evaluate the quality of your datasets and benchmark model performance.
23+
24+
### 📦 Dataset Management
25+
Organize your projects, manage versions, and interact with the dataset API.
26+
27+
### 🔌 Extensions
28+
Extend Compileo with plugins or develop your own modules.
29+
30+
---
31+
32+
For a high-level overview of the project, please return to the [Introduction](../index.md).

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ site_dir: ../site
4747
nav:
4848
- 🚀 Getting Started:
4949
- Introduction: index.md
50+
- Overview: userGuide/index.md
5051
- Docker Installation: userGuide/dockerInstall.md
5152
- API Authentication: userGuide/api_authentication.md
5253
- Logging: userGuide/logging.md

0 commit comments

Comments
 (0)