README GENERATOR

Writing documentation is easily one of the most tedious parts of software development, but it became a critical bottleneck for me when my previous projects were sent back to be reshipped because the documentation didn't meet strict standards. To fix this, I built and published my first official extension, AI Based README Generator, which hardwires the exact structural layout required by the Stardance guide directly into a native VS Code utility. By utilizing the vscode.workspace.fs API to dynamically read local source files and integrating a 12,000-character safety valve to completely bypass AI token limit crashes, the extension effortlessly extracts core project logic, filters out non-code asset clutter, and hooks straight into the native GitHub Copilot model stream.

The core breakthrough of this tool is its strict adherence to the """Stardance guide to a perfect README""", using that exact framework as its baseline prompt to force the AI to generate structured, reviewer-ready documentation instead of generic fluff. When a developer triggers the command from their palette, the extension validates the workspace, executes a filesystem loop to analyze functional code, and maps it directly to the guide's mandatory sequence—including concise titles, hero asset placeholders, hyper-efficient quick starts, and deep architectural tradeoffs. It then dynamically streams that compliant markdown directly into a pristine, unsaved virtual editor tab, allowing me to flawlessly ship my project with complete confidence that it perfectly matches the evaluation criteria.