Skip to content

Commit 6bbad4b

Browse files
ScottBobisidoresatorstefan
committed
. d Better docs and agents.md
Co-authored-by: Llewellyn Falco <llewellyn.falco@gmail.com> Co-authored-by: Stefan Sator <satorstefan@users.noreply.github.com>
1 parent 931d57c commit 6bbad4b

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,8 @@ No files were deleted.
5050
```
5151
<sup><a href='/test_remove_abandoned_files.test__reject.approved.txt#L1-L7' title='Snippet source file'>snippet source</a> | <a href='#snippet-test_remove_abandoned_files.test__reject.approved.txt' title='Start of snippet'>anchor</a></sup>
5252
<!-- endSnippet -->
53+
54+
## See Also
55+
56+
- [Agents](docs/agents.md) - AI agent instructions and script documentation
57+
- [Map](docs/map.md) - Codebase structure overview

docs/agents.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Agents
2+
3+
## About the Scripts
4+
5+
ApprovalTests (Java, Python, Go, Node) creates a `.approval_tests_temp/` directory when run,
6+
and will download these scripts into that directory when needed.
7+
8+
### approve_all.py
9+
10+
Batch approves all mismatched approval test files by copying `.received` files to `.approved` files.
11+
12+
**Usage:** `.approval_tests_temp/approve_all.py`
13+
14+
**Behavior:**
15+
- Displays count of mismatched files
16+
- Copies `.received` to `.approved` for each mismatch
17+
- Reports number of files approved
18+
19+
### remove_abandoned_files.py
20+
21+
Identifies and optionally deletes orphaned `.approved` files that no longer have corresponding tests.
22+
23+
**Usage:** `.approval_tests_temp/remove_abandoned_files.py`
24+
25+
**Behavior:**
26+
- Lists all abandoned files found
27+
- Prompts user for confirmation before deletion
28+
- Deletes files only if user confirms

docs/map.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Codebase Map
2+
3+
## Directory Structure
4+
5+
**Root**
6+
- Main scripts: `approve_all.py`, `remove_abandoned_files.py`
7+
- Tests: `test_*.py` and `*.approved.txt` files
8+
- Build/test scripts: `build_and_test*`, `format_code*`
9+
- Configuration: `pyproject.toml`, `requirements.dev.txt`, `mdsnippets.json`
10+
11+
**docs/**
12+
- Documentation files
13+
14+
**docs/how_to/**
15+
- Usage guides and instructions
16+
17+
**.github/**
18+
- GitHub Actions workflows and CI configuration

0 commit comments

Comments
 (0)