Skip to content

Commit 14f103b

Browse files
author
naman-msft
committed
updated readme around tool
1 parent 8fa1a14 commit 14f103b

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

tools/README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Welcome to ADA! This tool helps you convert documents and troubleshoot errors ef
1010
- Redacts Personally Identifiable Information (PII) from Exec Doc result blocks.
1111
- Automatically identifies and generates dependency files referenced in documents.
1212
- Performs comprehensive security vulnerability analysis on Exec Docs.
13-
- Runs tests on the converted document using the Innovation Engine.
1413
- Logs execution data to a CSV file for analytics.
1514

1615
## Prerequisites
@@ -150,6 +149,33 @@ Welcome to ADA! This tool helps you convert documents and troubleshoot errors ef
150149
151150
8. **Logging**: Logs execution data to `execution_log.csv`.
152151
152+
## Advanced Features
153+
154+
### Dependency File Management
155+
ADA can identify, generate, and manage auxiliary files referenced in your Exec Docs:
156+
- Automatically detects files referenced in the document
157+
- Creates dependency files with proper formatting based on file type
158+
- Tracks existing files to prevent overwriting user modifications
159+
- Intelligently updates dependency files when errors are detected
160+
- Regenerates dependencies when major document changes occur
161+
162+
### Error Resolution System
163+
When errors occur during testing, ADA employs a sophisticated resolution system:
164+
- Analyzes errors to determine if they originate in main document or dependency files
165+
- Uses progressive troubleshooting strategies for persistent errors
166+
- Only counts attempts against the maximum when fixing the main document
167+
- Provides specific strategies for different error patterns
168+
- Remembers previous errors to avoid repetitive solutions
169+
170+
### Progressive Error Strategies
171+
ADA uses increasingly more aggressive strategies when encountering repeated errors:
172+
1. Target specific issues identified in error messages
173+
2. Simplify complex code blocks into smaller, manageable steps
174+
3. Remove problematic result blocks that may be causing validation issues
175+
4. Try alternative commands or approaches to achieve the same result
176+
5. Completely redesign problematic sections with simpler implementations
177+
6. Remove and rebuild problematic sections from scratch
178+
153179
## Logging
154180
155181
The script logs the following data to `execution_log.csv`:

0 commit comments

Comments
 (0)