AutoDoctor Documentation

About This Documentation

This documentation is organized for three audiences:

• DIY/home users who want a safe first run and clear next steps.
• Technical users who need runtime, configuration, and service operations.
• Developers who need architecture, contracts, and extension details.

Choose Your Path

• DIY path: Getting Started
• Technical path: Technical Guide
• Developer path: Developer Guide
• Fast lookup: Reference
• Problem solving: Troubleshooting
• Quick answers: FAQ

Product Scope

AutoDoctor is a Windows diagnostics and remediation toolchain with:

• PowerShell diagnostic agent (agent/)
• SQLite persistence (db/autodoctor.db)
• FastAPI service (server/api/)
• Browser dashboard (/dashboard)

It is designed for local or controlled administrative environments.

Core Capabilities

• Run host diagnostics (CPU, memory, disk, network, events, updates, drivers, software)
• Compute root-cause issues and health score
• Execute remediation actions
• Persist diagnostics, alerts, and telemetry to SQLite
• Serve health/status APIs and dashboard views

Documentation Principles

• Plain language first, with technical terms defined when used.
• Consistent section structure across guides.
• Actionable examples with expected outcomes.
• Accessibility-first heading and link style.

Canonical URL Strategy (Recommended)

Use one canonical host for all published docs pages.

• Set baseURL in Hugo to your production docs host.
• Keep one canonical path per page (slug + section path).
• Add aliases only for legacy URLs during migration.
• Avoid publishing duplicate docs under multiple section roots.

For this project, publish docs under https://projectindexly.com/autodoctor/ and redirect old paths to that canonical root.

Next Steps

• Start with Requirements
• Continue with Installer Guide
• Review Configuration Precedence