Skip to content

Commit 1ab9495

Browse files
committed
clean docs
1 parent 557903d commit 1ab9495

11 files changed

+47
-3
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

β€Ždoc/README.mdβ€Ž

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Documentation
2+
3+
This folder contains all the documentation for the project.
4+
5+
## πŸ“¦ Getting Started
6+
7+
- **[RELEASE_NOTES.md](RELEASE_NOTES.md)** - Current release information and quick start guide
8+
9+
## πŸ”§ Build & Setup
10+
11+
- **[BUILD_GUIDE.md](BUILD_GUIDE.md)** - Client build instructions and development setup
12+
13+
## 🎨 UI/UX Documentation
14+
15+
- **[COLOR_THEME_GUIDE.md](COLOR_THEME_GUIDE.md)** - Color theme and styling guidelines
16+
17+
## πŸ› Bug Fixes & Improvements
18+
19+
### Authentication
20+
- **[AUTHENTICATION_FIX.md](AUTHENTICATION_FIX.md)** - Fixed "permission denied" errors and race conditions in login flow
21+
22+
### Annotation System
23+
- **[ANNOTATION_EDITING_FIX.md](ANNOTATION_EDITING_FIX.md)** - Enabled editing of submitted annotations with smart change detection
24+
- **[COMMENT_NEWLINE_HANDLING.md](COMMENT_NEWLINE_HANDLING.md)** - Multi-line comment support with proper newline preservation
25+
26+
### Rubric & Data Management
27+
- **[RUBRIC_FORMAT_UPDATE.md](RUBRIC_FORMAT_UPDATE.md)** - Improved rubric question parsing to handle newlines in descriptions
28+
- **[TRACE_RANDOMIZATION.md](TRACE_RANDOMIZATION.md)** - Per-user randomized but consistent trace ordering
29+
30+
## 🧩 Component Documentation
31+
32+
- **[README_Pagination.md](README_Pagination.md)** - Pagination component documentation
33+
- **[README_TraceDataViewer.md](README_TraceDataViewer.md)** - Trace data viewer component documentation
34+
35+
## πŸ”™ Back to Main Documentation
36+
37+
- [Main README](../README.md) - Project overview and configuration
38+
- [License](../LICENSE.md) - License information
39+
- [Security](../SECURITY.md) - Security policies and reporting
40+
- [Notice](../NOTICE.md) - Legal notices
41+
File renamed without changes.
File renamed without changes.

β€ŽRELEASE_NOTES.mdβ€Ž renamed to β€Ždoc/RELEASE_NOTES.mdβ€Ž

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,17 +64,20 @@ uv run uvicorn server.app:app --reload --port 8000
6464

6565
## πŸ”§ Configuration
6666

67-
See the main [README.md](README.md) for detailed configuration options including:
67+
See the main [README.md](../README.md) for detailed configuration options including:
6868
- Database setup
6969
- Databricks integration
7070
- Authentication configuration
7171
- Workshop creation
7272

7373
## πŸ“š Documentation
7474

75-
- [BUILD_GUIDE.md](client/BUILD_GUIDE.md) - Client build instructions
75+
- [BUILD_GUIDE.md](BUILD_GUIDE.md) - Client build instructions
76+
- [COLOR_THEME_GUIDE.md](COLOR_THEME_GUIDE.md) - UI color theme guide
7677
- [AUTHENTICATION_FIX.md](AUTHENTICATION_FIX.md) - Authentication details
7778
- [ANNOTATION_EDITING_FIX.md](ANNOTATION_EDITING_FIX.md) - Annotation editing
79+
- [COMMENT_NEWLINE_HANDLING.md](COMMENT_NEWLINE_HANDLING.md) - Comment newline handling
80+
- [RUBRIC_FORMAT_UPDATE.md](RUBRIC_FORMAT_UPDATE.md) - Rubric format improvements
7881
- [TRACE_RANDOMIZATION.md](TRACE_RANDOMIZATION.md) - Randomization logic
7982

8083
## πŸ› Known Issues
@@ -83,5 +86,5 @@ None at this time. Please report issues on GitHub.
8386

8487
## πŸ“ License
8588

86-
See [LICENSE.md](LICENSE.md) for details.
89+
See [LICENSE.md](../LICENSE.md) for details.
8790

File renamed without changes.

0 commit comments

Comments
Β (0)