Tech Story Teller
An n8n-powered automation pipeline that analyzes Rust source code and generates comprehensive technical documentation through multi-stage LLM processing.Overview
Tech Story Teller transforms Rust codebases into human-readable documentation by:- Receiving GitHub webhooks on code changes
- Fetching and parsing Rust source files
- Extracting AST-like structural information
- Generating multi-level explanations (ELI5 to senior engineer)
- Verifying test coverage and suggesting improvements
- Delivering reports to Slack, Notion, or email
Pipeline Architecture
The system consists of four modular workflows that can be chained or triggered independently:| Workflow | Purpose |
|---|---|
| Workflow A | GitHub Webhook Receiver + File Fetcher |
| Workflow B | Rust File Structural Analysis (AST extraction) |
| Workflow C | Deep LLM Analysis: explanations, concepts, component maps |
| Workflow D | Test Coverage + Final Report Assembly |
Key Features
Multi-Level Documentation
- ELI5 Explanations: Simple analogies for newcomers
- Senior-Level Analysis: Deep technical breakdowns
- Function-by-Function: Detailed per-function documentation
- Rust Concepts: Identified patterns and idioms
Structural Analysis
For each function, the system extracts:- Name and signature
- Input parameters (typed)
- Return type
- Async/sync classification
- Pure/impure (stateful) classification
- Errors thrown
- External crates used
- Call relationships
Output Formats
- Mermaid diagrams showing file relationships
- Component interaction maps
- Test coverage reports
- Actionable fix suggestions
Technology Stack
- Orchestration: n8n workflow automation
- LLM: GPT-4o / GPT-4o-mini
- Integration: GitHub API, Slack, Notion
- Testing: Cargo test integration