-
Notifications
You must be signed in to change notification settings - Fork 21
Description
Documentation Issue #8:
Title: Clean Up Repository Root and Organize Documentation Files
Description: The repository root contains numerous markdown files that should be organized into appropriate directories. This cleanup will improve repository navigation and maintainability.
Current Issues:
Multiple implementation summaries and PR-related files in root
Gas optimization docs scattered
Issue-specific markdown files cluttering root
No clear documentation hierarchy
Files to Reorganize:
Root files to move/consolidate:
├── API_SPEC.md → Keep in root (core doc)
├── CREATE_PR_ISSUE_25.md → Move to .archive/ or delete
├── GAS_OPTIMIZATION.md → Move to docs/gas/
├── IMPLEMENTATION_ISSUE_14.md → Move to .archive/ or delete
├── IMPLEMENTATION_SUMMARY.md → Move to .archive/ or delete
├── IMPLEMENTATION_SUMMARY_ISSUE_25.md → Move to .archive/ or delete
├── MULTISIG_EMERGENCY_PAUSE.md → Move to docs/security/
├── PR_SUMMARY_ISSUE_7.md → Move to .archive/ or delete
├── PR_TEMPLATE_ISSUE_14.md → Move to .github/
├── PUSH_AND_PR_COMMANDS.md → Move to .archive/ or delete
├── QUICK_REFERENCE_ISSUE_14.md → Move to docs/quick-reference/
├── QUICK_START_GAS_OPTIMIZATION.md → Move to docs/gas/
└── frontend-mock-test.js → Move to tests/ or delete
Proposed Structure:
PredictIQ/
├── .archive/ # Historical/deprecated docs
├── .github/
│ ├── ISSUE_TEMPLATE/
│ ├── PULL_REQUEST_TEMPLATE.md
│ └── workflows/
├── docs/
│ ├── gas/
│ │ ├── GAS_OPTIMIZATION.md
│ │ └── QUICK_START_GAS_OPTIMIZATION.md
│ ├── security/
│ │ └── MULTISIG_EMERGENCY_PAUSE.md
│ └── quick-reference/
│ └── QUICK_REFERENCE_ISSUE_14.md
├── github-issues/ # Generated issue templates
├── README.md
├── CONTRIBUTING.md
├── DEVELOPMENT.md
├── ARCHITECTURE.md
├── API_SPEC.md
├── CHANGELOG.md # To be created
└── LICENSE
Tasks:
Create .archive/ directory for historical docs
Move implementation summaries to archive
Move PR-related files to .github/ or archive
Consolidate gas optimization docs
Move security docs to appropriate location
Update all internal links after moving files
Create .gitignore entries for temporary files
Update README with new documentation structure
Acceptance Criteria:
Root directory contains only essential docs
All documentation properly categorized
No broken links after reorganization
README updated with doc structure
Archive directory clearly labeled
Labels: documentation, cleanup, organization, high-priority