Auto Doc Readme

---
name: auto-doc-readme
description: Update README.md project structure section to match actual filesystem
type: skill
category: documentation
agents: [doc-maintainer]
knowledge: []
mcp_servers: [filesystem]
axioms: [A1, A3]
---

# Auto-Doc README

## Purpose

Scan project directory tree and update the project structure section in `README.md` to accurately reflect the current filesystem layout. Ensures documentation stays synchronized with actual codebase organization.

## When to Use

- After adding new directories or files
- After reorganizing project structure
- After renaming or moving directories
- When README structure section becomes outdated
- As part of regular documentation maintenance

## Prerequisites

- Python 3.10+ installed
- Access to project root directory
- Write access to `README.md`

## Process

1. **Scan filesystem**: Recursively traverse project root directory
2. **Build tree structure**: Generate hierarchical directory tree representation
3. **Locate README section**: Find "Project Structure" or similar section in README.md
4. **Generate markdown tree**: Format directory tree as markdown code block or nested list
5. **Update README**: Replace existing structure section with updated tree
6. **Preserve formatting**: Maintain README formatting conventions and other content

## Example Usage

```bash
# Update README structure section
python scripts/tools/doc-maintainer.py --readme-structure

# Preview changes before updating
python scripts/tools/doc-maintainer.py --readme-structure --dry-run
```

## Output

- Updated `README.md` with current project structure section
- Directory tree showing all files and folders (respecting .gitignore patterns)

## Best Practices

- Run after adding, removing, or reorganizing project directories
- Use `--dry-run` to preview structure changes before applying
- Verify the generated tree respects `.gitignore` patterns
- Keep the README structure section as the authoritative project layout reference