Skip to content

Commit 4997ca7

Browse files
committed
Update README with documentation section and project title
- Add project title and description - Add documentation section linking to /doc folder - Remove broken README_MLflow_Sync.md reference
1 parent 1ab9495 commit 4997ca7

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Workshop Annotation Platform
2+
3+
A collaborative platform for annotating and evaluating LLM traces with MLflow integration, discovery phases, and inter-rater reliability analysis.
4+
5+
## 📚 Documentation
6+
7+
For detailed documentation, see the [/doc](doc/) folder:
8+
9+
- **[Release Notes](doc/RELEASE_NOTES.md)** - Latest release information and quick start
10+
- **[Build Guide](doc/BUILD_GUIDE.md)** - Client build instructions
11+
- **[Authentication Fix](doc/AUTHENTICATION_FIX.md)** - Authentication improvements
12+
- **[Annotation Editing](doc/ANNOTATION_EDITING_FIX.md)** - Annotation editing features
13+
- **[All Documentation](doc/README.md)** - Complete documentation index
14+
115
## 📋 Prerequisites
216

317
- **Python 3.11+**
@@ -202,8 +216,6 @@ mlflow.log_feedback(
202216
)
203217
```
204218

205-
📖 **See [README_MLflow_Sync.md](README_MLflow_Sync.md) for complete documentation**
206-
207219
## ⚙️ Configuration
208220

209221
### Authentication Configuration (`config/auth.yaml`)

0 commit comments

Comments
 (0)