Skip to content

Commit cad4e06

Browse files
committed
Organize markdown files into docs/ and notes/
Organizational change: Move markdown documentation from root to structured directories for better project organization. Files kept in root (2): - README.md - Main project documentation - CLAUDE.md - AI assistant instructions Files moved to docs/ (3 new + existing): - FILTER_TESTING_GUIDE.md - QUICK_START.md - UMAP_QUICK_START.md + Added docs/README.md index Files moved to notes/ (16 new): Development notes, implementation summaries, and reports: - COMMUNITY_MECH_PLAN.md - FINAL_SUMMARY.md - GROWTH_MEDIA_FEATURE.md - IMPLEMENTATION_SUMMARY.md - NETWORK_CURATION_REPORT.md - PHASE_1_COMPLETION.md through PHASE_5_COMPLETION.md - PROJECT_COMPLETION_SUMMARY.md - PR_DESCRIPTION.md - PR_REVIEW_FIXES_SUMMARY.md - UMAP_FILTER_IMPLEMENTATION.md - UMAP_FINAL_SUMMARY.md - UMAP_IMPLEMENTATION_SUMMARY.md + Added notes/README.md index Rationale: - docs/ contains user-facing guides and documentation - notes/ contains development history and working documents - Root directory is now cleaner with only essential files
1 parent be302c3 commit cad4e06

21 files changed

Lines changed: 84 additions & 0 deletions
File renamed without changes.
File renamed without changes.

docs/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Documentation
2+
3+
This directory contains user-facing documentation and guides for the CommunityMech knowledge base.
4+
5+
## User Guides
6+
7+
### Getting Started
8+
- **QUICK_START.md** - Quick start guide for using CommunityMech
9+
- **UMAP_QUICK_START.md** - Quick start guide for UMAP visualization
10+
11+
### Feature Guides
12+
- **FILTER_TESTING_GUIDE.md** - Testing guide for filter panel functionality
13+
- **GROWTH_MEDIA_GUIDE.md** - Guide for growth media metadata
14+
- **UMAP_VISUALIZATION.md** - UMAP visualization documentation
15+
- **UMAP_COLOR_GUIDE.md** - Color scheme guide for UMAP plots
16+
17+
### Curation & Quality
18+
- **NETWORK_QUALITY_GUIDE.md** - Network quality assurance guide
19+
- **NETWORK_REPAIR_USER_GUIDE.md** - User guide for network repair tools
20+
- **CURATION_PROGRESS_REPORT.md** - Community curation progress
21+
- **CULTUREMECH_MAPPING_GUIDE.md** - CultureMech mapping guide
22+
23+
### Automation & Tools
24+
- **AUTOMATION_TOOLS.md** - Automation tools documentation
25+
- **LLM_SETUP_GUIDE.md** - LLM-assisted curation setup
26+
- **LLM_REPAIR_ROADMAP.md** - Roadmap for LLM repair capabilities
27+
- **pdf_fetching_capability.md** - PDF fetching feature documentation
28+
29+
## Main Project Documentation
30+
31+
See **../README.md** in the project root for:
32+
- Project overview and architecture
33+
- Installation and setup instructions
34+
- Core commands and workflows
35+
- LinkML schema documentation
36+
37+
## Developer Instructions
38+
39+
See **../CLAUDE.md** for AI assistant instructions and project conventions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)