Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
210 lines (163 loc) · 8.6 KB

DOCUMENTATION_INDEX.md

File metadata and controls

210 lines (163 loc) · 8.6 KB

PoshGuard Documentation Index

Complete guide to all PoshGuard documentation - Updated 2025-11-11

Use this page to navigate the docs. Prefer short, runnable examples and link deep-dives under docs/reference/.

🚀 Getting Started (5-10 minutes)

Start here if you're new to PoshGuard:

📖 Core Documentation

Architecture & Design

Integration Guides

Security

📚 Reference Documentation

API & Configuration

Testing

Performance

Analysis & Reports

👨‍💻 Development

Contributing

CI/CD

Workflows

Tools Documentation

🎯 Runbooks & Examples

📊 Audit Reports & Change History

Recent Audits (2025-11-11)

Historical Reports (tests/ directory)

Changelog

  • Changelog - Version history and release notes

📂 Directory Structure

PoshGuard/
├── README.md                 # Project overview
├── CONTRIBUTING.md           # How to contribute
├── CODE_OF_CONDUCT.md       # Community standards
├── SECURITY.md               # Security policy
├── AUDIT_REPORT.md          # Latest audit (2025-11-11)
├── ENHANCEMENTS_REPORT.md   # Latest enhancements (2025-11-11)
│
├── docs/                     # 📚 Main documentation
│   ├── DOCUMENTATION_INDEX.md (this file)
│   ├── quick-start.md       # 5-min quickstart
│   ├── install.md           # Installation
│   ├── usage.md             # Basic usage
│   ├── ARCHITECTURE.md      # System design
│   ├── BEGINNERS-GUIDE.md   # Comprehensive intro
│   ├── MCP-GUIDE.md         # Claude integration
│   ├── RIPGREP_*.md         # RipGrep guides
│   ├── PESTER_*.md          # Testing analysis
│   ├── TEST_*.md            # Testing guides
│   │
│   ├── reference/           # 📖 Reference docs
│   │   ├── SECURITY-FRAMEWORK.md
│   │   ├── ADVANCED-DETECTION.md
│   │   ├── GITHUB-SARIF-INTEGRATION.md
│   │   └── SARIF-IMPLEMENTATION-SUMMARY.md
│   │
│   ├── development/         # 👨‍💻 Developer docs
│   │   ├── README.md
│   │   ├── ENGINEERING-STANDARDS.md
│   │   ├── VERSION-MANAGEMENT.md
│   │   ├── DEPENDABOT.md
│   │   ├── ci-integration.md
│   │   ├── workflows/      # Workflow docs
│   │   └── tools/          # Tool-specific docs
│   │
│   ├── examples/            # 💡 Code examples
│   └── runbooks/            # 📋 Operations
│
└── tests/                   # 🧪 Testing documentation
    ├── README.md            # Test suite overview
    ├── TESTING_GUIDE.md     # How to run tests
    ├── PESTER_ARCHITECT_TEST_PLAN.md  # Test strategy
    ├── QUICK_REFERENCE.md   # Developer cheat sheet
    └── IMPLEMENTATION_SUMMARY_PESTER_ARCHITECT.md

🔍 Finding What You Need

By Task

By Role

📝 Documentation Standards

All PoshGuard documentation follows these standards:

  1. Markdown format - GitHub-flavored markdown
  2. Clear structure - Logical sections with headers
  3. Code examples - Runnable examples for all features
  4. Cross-references - Links to related docs
  5. Date stamps - Last updated dates on major docs
  6. Concise - Focus on practical information

🆘 Getting Help

Last Updated: 2025-11-11 Documentation Status: ✅ Current and Complete Total Documents: 60+ files across docs/, tests/, and root