Skip to content

Latest commit

 

History

History
197 lines (150 loc) · 6.08 KB

File metadata and controls

197 lines (150 loc) · 6.08 KB

Documentation Index

Welcome to the inVtero.net documentation! This index will help you find the information you need.

📖 Quick Navigation

🚀 Getting Started

👤 For Users

💻 For Developers

📋 Additional Resources

🎯 Documentation by Purpose

I want to...

Install inVtero.net

INSTALLATION.md

  • Windows setup
  • Linux/macOS setup
  • Symbol server configuration
  • Troubleshooting installation issues

Analyze a memory dump

USER_GUIDE.md → Quick Start → EXAMPLES.md → Quick Examples

Understand how it works

ARCHITECTURE.md

  • System design
  • Detection algorithms
  • Data flow diagrams

Write Python scripts

PYTHON_SCRIPTING.md

  • Setup and basics
  • Memory access
  • Working with structures
  • Advanced techniques

Use the API

API_REFERENCE.md

  • Core classes
  • Memory access
  • Symbol resolution
  • Configuration options

Contribute code

DEVELOPMENT.md

  • Development environment setup
  • Building from source
  • Coding standards
  • Pull request process

Solve a problem

TROUBLESHOOTING.md

  • Installation issues
  • Runtime errors
  • Symbol problems
  • Performance issues

See real examples

EXAMPLES.md

  • Memory forensics scenarios
  • VM introspection
  • Malware analysis
  • Incident response

📊 Documentation Statistics

  • Total Pages: 9 major documentation files
  • Total Words: ~60,000+ words
  • Code Examples: 50+ complete examples
  • Diagrams: 15+ mermaid visualizations
  • Use Cases: 10 detailed scenarios

🎨 Visual Documentation

All documentation includes colorized, themed mermaid diagrams:

Diagrams Included:

  • ✅ Analysis workflow flowcharts
  • ✅ Architecture overview
  • ✅ Process detection state machines
  • ✅ Nested virtualization diagrams
  • ✅ VMware detection sequences
  • ✅ Troubleshooting decision trees
  • ✅ Use case mind maps
  • ✅ Analysis pattern graphs

🔍 Search Guide

By Topic:

Memory Dump Formats

Process Detection

Hypervisor Analysis

Symbol Resolution

Performance

Python Scripting

Integrity Verification

📚 Reading Paths

Path 1: New User

  1. README.md - Overview
  2. INSTALLATION.md - Setup
  3. USER_GUIDE.md - Quick Start
  4. EXAMPLES.md - Example 1

Path 2: Developer

  1. ARCHITECTURE.md - Understand design
  2. API_REFERENCE.md - Learn API
  3. DEVELOPMENT.md - Setup dev environment
  4. CONTRIBUTING.md - Contribution process

Path 3: Scripter

  1. USER_GUIDE.md - Basic concepts
  2. PYTHON_SCRIPTING.md - Scripting guide
  3. API_REFERENCE.md - API reference
  4. EXAMPLES.md - Real scenarios

Path 4: Researcher

  1. ARCHITECTURE.md - Technical details
  2. EXAMPLES.md - Research examples
  3. API_REFERENCE.md - Deep API knowledge
  4. PYTHON_SCRIPTING.md - Advanced techniques

🆘 Getting Help

If you can't find what you're looking for:

  1. Check TROUBLESHOOTING.md - Most common issues are covered
  2. Search this index - Use Ctrl+F to find topics
  3. Check GitHub Issues - Search existing issues
  4. Create new issue - Use the templates provided

📝 Documentation Updates

This documentation was created for planning the new version of inVtero.net.

Last Updated: 2025-11-19

Version: Comprehensive documentation release

Coverage: All aspects of installation, usage, development, and troubleshooting


Ready to get started?INSTALLATION.md

Want to try an example?EXAMPLES.md

Need help?TROUBLESHOOTING.md