Add User Documentation

[josecelano]

Add User Documentation

Type: Task
Priority: High
Parent Epic: #10 - UI Layer Destroy Command
Estimated Effort: 2-3 hours

---

📋 Issue Overview

Create comprehensive user-facing documentation for the destroy command. Update existing documentation to reflect the implemented CLI interface and remove references to unimplemented features.

🎯 Problem Statement

The current user documentation at docs/user-guide/commands/destroy.md contains placeholder content and references to unimplemented commands (provision, list). After implementing the destroy CLI command (Issue #23), we need to:

1. Update documentation to match the actual implementation
2. Remove references to unimplemented commands
3. Provide comprehensive usage guidance
4. Add troubleshooting information

🎯 Goals

• Update existing user documentation to reflect actual destroy command implementation
• Remove references to unimplemented commands (provision, list)
• Document command usage and examples
• Document available flags and options
• Add comprehensive troubleshooting section
• Document safety considerations

📦 Scope

Primary File to Update

• docs/user-guide/commands/destroy.md - Main destroy command documentation

Content Areas

1. Command Synopsis: Exact syntax and parameters
2. Usage Examples: Common scenarios and use cases
3. Output Examples: What users should expect to see
4. Error Handling: Common errors and how to resolve them
5. Safety Considerations: Warnings about destructive operations
6. Troubleshooting: Step-by-step problem resolution

Remove Unimplemented References

Clean up any mentions of:

• torrust-tracker-deployer provision (not implemented)
• torrust-tracker-deployer list (not implemented)
• Advanced flags not implemented in MVP (--force, --yes)

✅ Acceptance Criteria

Documentation Requirements

• docs/user-guide/commands/destroy.md updated with actual implementation details
• All references to unimplemented commands removed
• Command syntax documented accurately
• Usage examples provided for common scenarios
• Expected output examples included
• Error messages and troubleshooting section added
• Safety considerations and warnings documented
• Prerequisites and dependencies clearly stated

Content Quality

• All markdown linting passes successfully
• Documentation follows project style guidelines
• Examples are tested and accurate
• Troubleshooting steps are actionable
• Cross-references to related documentation included

Example Content Structure

# Destroy Command

## Synopsis
torrust-tracker-deployer destroy <ENVIRONMENT_NAME>

## Description
Completely destroys a deployment environment...

## Examples
...

## Troubleshooting
...

## Safety Considerations
...

Testing Requirements

• All command examples in documentation are tested and work
• Error scenarios documented are reproducible
• Troubleshooting steps verified to resolve issues
• Documentation reviewed for accuracy and completeness

🔍 Implementation Approach

1. Review Current Documentation: Audit existing destroy.md content
2. Test Actual Implementation: Use destroy command (from Issue Add Clap Subcommand Configuration #23) to verify behavior
3. Document Real Usage: Replace placeholder content with actual examples
4. Clean Up References: Remove unimplemented command mentions
5. Add Troubleshooting: Based on common issues and error patterns
6. Review and Polish: Ensure clarity and completeness

🔗 Related Issues

• Parent Epic: EPIC: UI Layer Destroy Command #10 (UI Layer Destroy Command)
• Follows: Add Clap Subcommand Configuration #23 (Add Clap Subcommand Configuration) - documents the implemented CLI
• Related: Fix E2E Infrastructure Preservation #21 (Fix E2E Infrastructure Preservation) - enables testing workflow for documentation accuracy

📚 Related Documentation

• User Guide Structure
• Contributing Guidelines - Documentation
• Development Principles
• Error Handling Guide

---

Full specification: See docs/issues/add-user-documentation.md