Goblin Scout v0.1.0 (Alpha)

Goblin Scout v0.1.0 (Alpha Release)

First release of Goblin Scout, a Git repository documentation tool that generates structured markdown files from your codebase.

Features in this Release

Repository Processing

• Automatic cloning of new repositories
• Smart updating of existing repositories
• Git metadata extraction (contributors, releases)
• Repository tag validation

Documentation Generation Modes

1. Single File Mode

   • Combined codebase overview in one markdown file
   • Hierarchical file structure preserved in headers

2. Multi-File Mode

   • Separate markdown files per source file
   • Original directory structure maintained
   • Complete metadata per file

3. Dataset Mode

   • Smart code chunking (≤750 characters)
   • UUID assignment for each code section
   • JSON conversion support
   • Structure-aware chunk boundaries

Metadata Features

• Comprehensive file statistics and paths
• Contributor analysis with commit tracking
• Release version and date tracking
• Direct GitHub file URL generation
• Automatic language detection
• UUID tracking system

Requirements

• Git repository with at least one tag
• Valid Git repository URL
• Write permissions for output directory

Installation

git clone https://github.com/yourusername/goblin_scout.git
cd goblin_scout
cargo build --release

Note: This is an alpha release intended for early testing and feedback. Some features may be unstable or subject to change.