Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,14 @@ db/modules_metadata_base.pstore

# local scratch/log file
file.txt

# Prevent temporary review/report files in root
# These should go in docs/reviews/, docs/reports/, or docs/resolution/
/*_REVIEW*.md
/*_REPORT*.md
/*_RESOLUTION*.md
/*_RESPONSE*.md
/*_ACTION_ITEMS*.md
/*_SUMMARY*.md
/*_COMPLETE*.md
/*_VERIFICATION*.md
59 changes: 59 additions & 0 deletions docs/ORGANIZED_DOCS_INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Organized Documentation Index

This document provides an index to the reorganized documentation files that were moved from the repository root to maintain a clean project structure.

## Directory Structure

### Reviews (`docs/reviews/`)
CI/CD and code quality review reports:
- Amazon Q reviews and action items
- CI/CD review responses and resolutions
- Code cleanliness improvements
- Comprehensive review reports

### Migration (`docs/migration/`)
Documentation related to the Ruby-to-Python migration:
- Conversion verification reports
- MSF Python migration status
- Python-first naming conventions
- Ruby removal verification

### Resolution (`docs/resolution/`)
Issue resolution and completion reports:
- Individual issue resolutions
- Round-based completion verification
- Task completion reports

### Guides (`docs/guides/`)
User and developer guides:
- Manual merge guide
- Startup methods documentation
- Comprehensive testing guide

### Reports (`docs/reports/`)
Project reports and analysis:
- Merge order documentation
- MSF suite bug fix summaries
- Testing reports
- PR merge analysis

## Essential Root-Level Documentation

The following documentation files remain in the repository root for easy access:
- `README.md` - Main project documentation
- `CONTRIBUTING.md` - Contribution guidelines
- `LICENSE.md` - License information
- `CHANGELOG.md` - Version history
- `CODE_OF_CONDUCT.md` - Community guidelines
- `SECURITY.md` - Security policies
- `QUICKSTART.md` - Quick start guide
- `TESTING.md` - Testing documentation

## Navigation

To view specific documentation:
1. Navigate to the appropriate subdirectory based on the topic
2. Check the file listings above to find relevant documentation
3. Use GitHub's search feature to find specific content

For website documentation, see `docs/README.md` for information about the docs site at https://docs.metasploit.com/
34 changes: 34 additions & 0 deletions docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,37 @@ To contribute to any of these items:
- msfrc environment activation is the recommended usage pattern
- 4,948 Python modules available
- All functionality verified working with comprehensive test suite (17/17 tests passing)

---

## CI/CD Review Follow-up (2026-01-16)

### Code Cleanliness - Large Files Analysis ✅

The CI/CD review identified several files exceeding 500 lines. Analysis completed:

**Files That Are Appropriately Large (No Action Needed):**

1. **CVE Exploit Files** (`data/exploits/CVE-2019-12477/epicsax*.ts`) - ✅ Legitimate PoCs
2. **Core Transpiler Logic** (`ruby2py/py2ruby/transpiler.py`, `tools/ast_transpiler/ast_translator.py`) - ✅ Complex AST transformations
3. **LLVM Instrumentation** (`lib/msf/util/llvm_instrumentation.py`) - ✅ Specialized domain logic
4. **Test Files** (`test/test_comprehensive_suite.py`, `test/python_framework/test_*.py`) - ✅ Comprehensive test coverage
5. **Binary Analysis Tools** (`lib/rex/binary_analysis/*.py`) - ✅ Complex analysis algorithms
6. **Rootkit Simulator** (`modules/malware/linux/rootkit_simulator.py`) - ✅ Single cohesive class

**Conclusion**: All large files are appropriately sized for their functionality. Splitting would harm logical cohesion and readability.

### Repository Organization - COMPLETED ✅

- [x] Moved 35 temporary review/report markdown files from root to `docs/` subdirectories
- [x] Organized documentation into logical categories:
- `docs/reviews/` - CI/CD and code quality reviews
- `docs/migration/` - Ruby-to-Python migration documentation
- `docs/resolution/` - Issue resolution reports
- `docs/guides/` - User and developer guides
- `docs/reports/` - Project reports and analysis
- [x] Created `docs/ORGANIZED_DOCS_INDEX.md` for easy navigation
- [x] Updated `.gitignore` to prevent future clutter from temporary review files
- [x] Root directory now contains only 8 essential documentation files

**Result**: Repository is now clean and well-organized per best practices
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.
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.
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.
File renamed without changes.
File renamed without changes.