This directory contains the reconstructed documentation artifacts for Project Octopus, generated following the Project Repository Reconstruction Roadmap (v1.0).
- PROJECT_EVIDENCE.md - Pass A Evidence Extraction Log containing raw facts, file counts, schema extractions, and empirical benchmark data directly gathered from the repository without inference.
- PROJECT_MANIFEST.md - Phase 0 Project Inventory Manifest detailing the directory hierarchy, technology stack, Python module components, and verification profiles.
- PROJECT_OVERVIEW.md - Phase 1 Purpose & Overview documenting the core problem statement, engineering goals, target users, scope, non-goals, and design philosophy.
- ARCHITECTURE.md - Phase 2 System Architecture detailing module responsibilities, Mermaid flowcharts, execution lifecycle, fallback sandbox wrappers, and reporting engines.
- HISTORY.md - Phase 3 Project Evolution detailing the 106 release milestones (
v0.0.1tov1.0.6), major pivots, timeline diagrams, and standards alignment. - DESIGN_DECISIONS.md - Phase 4 Engineering Rationale documenting trade-offs, rejected alternatives, security sandboxing choices, and reporting standards.
- FEATURES.md - Phase 5 Feature Inventory detailing core platform engines, 8 Validation Profiles, AST fallback scanners, and multi-format report outputs.
- INSTALL.md - Phase 6 Installation & Setup Guide covering prerequisites, environment setup, dependency installation, and verification commands.
- USAGE.md - Phase 7 Usage & Operations Guide detailing quick start workflows, output report formats, and CLI parameter references.
- API.md - Phase 8 API & Core Reference documenting primary classes (
ProjectProfiler,SandboxScannerWrapper), operational functions, parameters, and signatures. - CONFIGURATION.md - Phase 9 System Configuration & Profile Reference detailing CLI parameters, Validation Profile dictionaries, and output report schemas.
- SECURITY.md - Phase 10 Security Architecture & Threat Model documenting defense-first boundaries, threat vectors, SARIF 2.1.0 standards mapping, and responsible disclosure controls.
- PERFORMANCE.md - Phase 11 Performance Benchmarks & Efficiency detailing empirical verification runtimes, profile filtering gains, and Termux/PRoot mobile footprint.
- TESTING.md - Phase 12 Testing Strategy & Verification Framework documenting syntax template encoders, test suite wrapping, and verdict outcome categorization.
- RESEARCH.md - Phase 13 Research & Security Taxonomy Ledgers documenting standards integration (OWASP, MITRE ATT&CK, NIST, CAPEC/CWE), experimental hypotheses, and findings.
- LIMITATIONS.md - Phase 14 Technical Debt & System Limitations cataloging known issues, dynamic import parsing gaps, large SARIF report file sizes, and non-goals.
- PROJECT_STATUS.md - Phase 15 Living Project Status Report documenting recent engineering achievements (
v1.0.6), active research questions, and development priorities. - NEXT_STEPS.md - Phase 16 Future Roadmap & Next Steps outlining evidence-based future feature directions (multi-language AST parsers, real-time SARIF streaming, hardware auto-tuning, GitHub Actions pack).
- CHANGELOG.md - Phase 17 Release Changelog detailing release notes from
v0.5.0through currentv1.0.6. - CONTRIBUTING.md - Phase 17 Contributing Guide documenting contribution principles, defense-first scope policy, and pull request steps.
- CODE_OF_CONDUCT.md - Phase 17 Community Code of Conduct.
- READINESS_SCORE.md - Phase 19 Repository Readiness Score Report assigning an overall grade of 96/100 (A+).
- LINKEDIN_TOPICS.md - Phase 20 Professional Visibility detailing LinkedIn post concepts, hooks, problems, solutions, and metrics.
- ARTICLE_OUTLINES.md - Phase 20 Technical Article Outlines providing long-form technical article deep-dives.
- PORTFOLIO_HIGHLIGHTS.md - Phase 20 Portfolio Highlights summarizing core executive engineering accomplishments.
- INTERVIEW_TALKING_POINTS.md - Phase 20 Interview Talking Points & Resume Bullets providing resume bullet candidates and Q&A answers.
- SECURITY_DISCLAIMER.md - Security & Responsible Disclosure Disclaimer establishing defensive scope boundaries.