Skip to content

Commit cff2e0d

Browse files
committed
docs: [#220] update documentation with real command outputs and state management warnings
- Updated docs/e2e-testing/manual-testing.md: * Replaced all fake command output with real output from test runs * Removed all references to non-existent 'deploy' command * Updated state machine to reflect actual workflow (provision → configure → release → run) * Added comprehensive warnings about manual state editing dangers * Added 'Checking Logs for Diagnosis' section with examples * Updated command durations with real timing data * Fixed all command sequences and recovery procedures - Updated docs/user-guide/quick-start.md: * Replaced fake output with real command output * Updated complete workflow to show correct 5-step process * Changed Step 6 from 'test' to 'release' command * Added Step 7 'run' command (was missing) * Renumbered cleanup to Step 8 * Updated Quick Reference with correct command sequence * Fixed all timing information with real test data - Updated docs/e2e-testing/README.md: * Added manual-testing.md to documentation structure * Added link to manual testing guide in 'Learn More' section * Updated description to distinguish automated vs manual testing - Updated AGENTS.md: * Added Manual E2E Testing section with link to manual-testing.md * Listed key topics covered in the manual testing guide All markdown linting checks pass. Documentation now reflects actual system behavior with accurate command outputs, correct workflows, and proper warnings about state management.
1 parent aacdcd6 commit cff2e0d

File tree

4 files changed

+1086
-46
lines changed

4 files changed

+1086
-46
lines changed

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,10 @@ These principles should guide all development decisions, code reviews, and featu
135135
- `cargo run --bin e2e-deployment-workflow-tests` - Software installation, configuration, release, and run workflow tests (GitHub runner-compatible)
136136
- Pre-commit hook runs the split tests (`e2e-infrastructure-lifecycle-tests` + `e2e-deployment-workflow-tests`) for GitHub Copilot compatibility
137137
- See [`docs/e2e-testing/`](docs/e2e-testing/) for detailed information about CI limitations
138+
- **Manual E2E Testing**: For step-by-step manual testing with CLI commands, see [`docs/e2e-testing/manual-testing.md`](docs/e2e-testing/manual-testing.md). This guide covers:
139+
- Complete manual test workflow from template creation to deployment
140+
- Handling interrupted commands and state recovery
141+
- Troubleshooting common issues
142+
- Cleanup procedures for both application and LXD resources
138143

139144
Follow the project conventions and ensure all checks pass.

docs/e2e-testing/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ This guide explains how to run and understand the End-to-End (E2E) tests for the
66

77
- **[README.md](README.md)** - This overview and quick start guide
88
- **[architecture.md](architecture.md)** - E2E testing architecture, design decisions, and Docker strategy
9-
- **[running-tests.md](running-tests.md)** - How to run tests, command-line options, and prerequisites
9+
- **[running-tests.md](running-tests.md)** - How to run automated tests, command-line options, and prerequisites
10+
- **[manual-testing.md](manual-testing.md)** - Complete guide for running manual E2E tests with CLI commands
1011
- **[test-suites.md](test-suites.md)** - Detailed description of each test suite and what they validate
1112
- **[troubleshooting.md](troubleshooting.md)** - Common issues, debugging techniques, and cleanup procedures
1213
- **[contributing.md](contributing.md)** - Guidelines for extending E2E tests
13-
- **[advanced.md](advanced.md)** - Advanced techniques including manual testing and cross-environment registration
14+
- **[advanced.md](advanced.md)** - Advanced techniques including cross-environment registration
1415

1516
## 🧪 What are E2E Tests?
1617

@@ -66,6 +67,7 @@ For detailed prerequisites and manual setup, see [running-tests.md](running-test
6667
## 📚 Learn More
6768

6869
- **New to E2E testing?** Start with [test-suites.md](test-suites.md) to understand what each test does
70+
- **Want to run manual tests?** Follow [manual-testing.md](manual-testing.md) for step-by-step CLI workflow
6971
- **Running into issues?** Check [troubleshooting.md](troubleshooting.md)
7072
- **Want to understand the architecture?** Read [architecture.md](architecture.md)
7173
- **Adding new tests?** See [contributing.md](contributing.md)

0 commit comments

Comments
 (0)