Skip to content

Commit 5f1d7ad

Browse files
committed
docs: clean root directory and archive historical documentation
Major cleanup of root directory markdown files: CLEANUP ACTIONS: - Moved 37 historical markdown files from root to doc/.archive/ - Organized archive into logical categories: - phase1/, phase2/, phase3/ - Phase implementation summaries - working-docs/ - Operational documents and status reports - Created comprehensive archive index (doc/.archive/README.md) - Preserved all file history using git mv CONTENT INTEGRATION: - Extracted test script setup from AGENTS.md - Added 'Option A: Using Test Script' section to development-setup.md - Documented .venv_ci isolated testing workflow - Ensured all unique information preserved before archiving FINAL STATE: - Root directory now contains only 8 core files: * README.md, AGENTS.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md * LICENSE.md, NOTICE.md, SECURITY.md, SUPPORT.md - All historical docs organized in doc/.archive/ with full index - Archive README provides navigation and search guidance FILES ARCHIVED (37 total): Phase Docs (5): - PHASE_1_IMPLEMENTATION_SUMMARY.md → phase1/ - PHASE_2_COMPLETION_STATUS.md, PHASE_2_IMPLEMENTATION_SUMMARY.md → phase2/ - PHASE_3_COMPLETE.md, PHASE_3_PLAN.md → phase3/ Working Docs (32): Summary Reports: AGENT_CONSOLIDATION_SUMMARY, CONFIG_UPDATE_SUMMARY, DELIVERABLES_SUMMARY, DOCLING_REORGANIZATION_SUMMARY, and 6 more Analysis: BENCHMARK_RESULTS_ANALYSIS, CEREBRAS_ISSUE_DIAGNOSIS, CI_PIPELINE_STATUS, CODE_QUALITY_IMPROVEMENTS, and 9 more Quick Reference: QUICK_REFERENCE, DOCUMENTAGENT_QUICK_REFERENCE, STREAMLIT_QUICK_START, OLLAMA_SETUP_COMPLETE Completion: API_MIGRATION_COMPLETE, CONSOLIDATION_COMPLETE, PARSER_CONSOLIDATION_COMPLETE, REORGANIZATION_COMPLETE, DOCUMENTATION_CLEANUP_COMPLETE Planning: GIT_COMMIT_SUMMARY, ROOT_CLEANUP_PLAN This cleanup maintains professional root directory while preserving complete project history and documentation evolution. Closes documentation cleanup task.
1 parent 035c17b commit 5f1d7ad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+651
-3
lines changed

doc/.archive/README.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Documentation Archive
2+
3+
This directory contains historical documentation from previous development phases and implementation cycles. These files have been archived to maintain a clean root directory while preserving project history.
4+
5+
## Archive Organization
6+
7+
### Phase Documentation (`phase1/`, `phase2/`, `phase3/`)
8+
9+
Historical implementation summaries and completion status from major development phases:
10+
11+
- **phase1/**: `PHASE_1_IMPLEMENTATION_SUMMARY.md`
12+
- **phase2/**: `PHASE_2_COMPLETION_STATUS.md`, `PHASE_2_IMPLEMENTATION_SUMMARY.md`
13+
- **phase3/**: `PHASE_3_COMPLETE.md`, `PHASE_3_PLAN.md`
14+
15+
### Working Documents (`working-docs/`)
16+
17+
Operational documents created during development, including:
18+
19+
**Summary Reports:**
20+
21+
- `AGENT_CONSOLIDATION_SUMMARY.md` - Agent module consolidation details
22+
- `CONFIG_UPDATE_SUMMARY.md` - Configuration changes and updates
23+
- `DELIVERABLES_SUMMARY.md` - Project deliverables tracking
24+
- `DOCLING_REORGANIZATION_SUMMARY.md` - Docling integration reorganization
25+
- `DOCUMENT_PARSER_ENHANCEMENT_SUMMARY.md` - Parser improvements
26+
- `ITERATION_SUMMARY.md` - Development iteration summaries
27+
- `REORGANIZATION_SUMMARY.md` - Code reorganization efforts
28+
- `TEST_FIXES_SUMMARY.md` - Test suite fixes and improvements
29+
- `TEST_RESULTS_SUMMARY.md` - Test execution results
30+
- `TEST_VERIFICATION_SUMMARY.md` - Test verification activities
31+
32+
**Analysis & Status Documents:**
33+
34+
- `BENCHMARK_RESULTS_ANALYSIS.md` - Performance benchmark analysis
35+
- `CEREBRAS_ISSUE_DIAGNOSIS.md` - Cerebras integration diagnostics
36+
- `CI_PIPELINE_STATUS.md` - CI/CD pipeline status reports
37+
- `CODE_QUALITY_IMPROVEMENTS.md` - Code quality enhancements
38+
- `CONSISTENCY_ANALYSIS.md` - Codebase consistency checks
39+
- `DEPLOYMENT_CHECKLIST.md` - Deployment preparation and validation
40+
- `INTEGRATION_ANALYSIS_requirements_agent.md` - Requirements agent integration
41+
- `PR_UPDATE.md` - Pull request updates and changes
42+
- `PRE_TASK4_ENHANCEMENTS.md` - Pre-task enhancements
43+
- `DOCUMENT_AGENT_CONSOLIDATION.md` - Document agent consolidation work
44+
- `EXAMPLES_FOLDER_REORGANIZATION.md` - Examples directory restructuring
45+
- `STREAMLIT_UI_IMPROVEMENTS.md` - Streamlit interface enhancements
46+
- `TEST_EXECUTION_REPORT.md` - Detailed test execution reports
47+
48+
**Quick Reference & Setup:**
49+
50+
- `QUICK_REFERENCE.md` - General quick reference guide
51+
- `DOCUMENTAGENT_QUICK_REFERENCE.md` - Document agent quick start
52+
- `STREAMLIT_QUICK_START.md` - Streamlit setup and usage
53+
- `OLLAMA_SETUP_COMPLETE.md` - Ollama integration completion
54+
55+
**Completion Reports:**
56+
57+
- `API_MIGRATION_COMPLETE.md` - API migration completion
58+
- `CONSOLIDATION_COMPLETE.md` - Module consolidation completion
59+
- `DOCUMENTATION_CLEANUP_COMPLETE.md` - Documentation cleanup completion
60+
- `PARSER_CONSOLIDATION_COMPLETE.md` - Parser consolidation completion
61+
- `REORGANIZATION_COMPLETE.md` - Code reorganization completion
62+
63+
**Planning & Tracking:**
64+
65+
- `GIT_COMMIT_SUMMARY.md` - Git commit summaries and history
66+
- `ROOT_CLEANUP_PLAN.md` - Root directory cleanup planning
67+
68+
## Current Documentation
69+
70+
Active documentation is maintained in the parent `doc/` directory:
71+
72+
- **User Guides** (`doc/user-guide/`) - End-user documentation
73+
- **Developer Guides** (`doc/developer-guide/`) - Development setup and workflows
74+
- **Features** (`doc/features/`) - Feature documentation and specifications
75+
- **Architecture** (`doc/architecture/`) - System architecture and design
76+
- **Specifications** (`doc/specs/`) - Technical specifications and templates
77+
78+
## Why These Files Are Archived
79+
80+
These documents represent:
81+
82+
1. **Historical records** from completed development phases
83+
2. **Working documents** used during active development
84+
3. **Status reports** from specific implementation periods
85+
4. **Completion markers** indicating finished work
86+
87+
All unique and relevant information from these documents has been integrated into the current documentation structure. They are preserved here for:
88+
89+
- Historical reference and audit trails
90+
- Understanding project evolution
91+
- Tracking decision-making processes
92+
- Maintaining complete project history
93+
94+
## Accessing Archived Content
95+
96+
To view archived documentation:
97+
98+
```bash
99+
# List all archived files
100+
find doc/.archive -name "*.md" | sort
101+
102+
# Search for specific content
103+
grep -r "search term" doc/.archive/
104+
105+
# View a specific archived file
106+
cat doc/.archive/working-docs/FILENAME.md
107+
```
108+
109+
## Archive Maintenance
110+
111+
- **Created**: December 2024
112+
- **Purpose**: Root directory cleanup and documentation organization
113+
- **Retention**: Permanent (historical record)
114+
- **Updates**: Archive is append-only; files are not modified after archiving
115+
116+
---
117+
118+
*For current documentation, see the main [doc/README.md](../README.md)*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

AGENT_CONSOLIDATION_SUMMARY.md renamed to doc/.archive/working-docs/AGENT_CONSOLIDATION_SUMMARY.md

File renamed without changes.

API_MIGRATION_COMPLETE.md renamed to doc/.archive/working-docs/API_MIGRATION_COMPLETE.md

File renamed without changes.

BENCHMARK_RESULTS_ANALYSIS.md renamed to doc/.archive/working-docs/BENCHMARK_RESULTS_ANALYSIS.md

File renamed without changes.

CEREBRAS_ISSUE_DIAGNOSIS.md renamed to doc/.archive/working-docs/CEREBRAS_ISSUE_DIAGNOSIS.md

File renamed without changes.

0 commit comments

Comments
 (0)