Engineering
wiki-llms-txt avatar

wiki-llms-txt

Generates llms.txt and llms-full.txt files to provide LLM-friendly documentation and project context.

Introduction

The wiki-llms-txt skill is an essential tool for developers and technical writers aiming to make their project documentation accessible and effective for AI coding agents. By generating standardized llms.txt and llms-full.txt files, this skill creates a machine-readable entry point for language models, allowing them to better understand your project's architecture, constraints, and operational details. It follows the official llms.txt specification to ensure broad compatibility with modern LLM-based development tools and agents. This skill is particularly useful for maintaining up-to-date documentation that AI can reliably parse, reducing hallucinations by providing a clear 'source of truth' for the project's structure, API surfaces, and onboarding guides.

  • Automatically builds a discovery-ready llms.txt root file containing project summaries and navigation paths.

  • Produces a comprehensive llms-full.txt that inlines full markdown documentation, preserving essential frontmatter, citations, tables, and Mermaid diagrams.

  • Enforces strict documentation standards, including H1 project identification, blockquote-based summaries, and logical section ordering (Onboarding, Architecture, Deep Dive).

  • Performs automated validation to ensure all links resolve, blockquotes remain specific, and content is appropriately segmented for context windows.

  • Handles repository resolution by verifying remote URLs and current git branch status before initiating file generation.

  • Best used when onboarding new AI agents or updating your documentation suite for better visibility in AI-assisted coding environments.

  • Requires existing wiki pages to function effectively; can integrate with deep-wiki generation workflows if no documentation exists.

  • Operates by parsing existing markdown structures while stripping unnecessary YAML frontmatter for cleaner agent ingestion.

  • Users should resolve git repository context prior to execution to ensure relative paths and project URLs are correctly formatted.

  • Does not overwrite existing non-generated root llms.txt files to prevent loss of manual configuration.

Repository Stats

Stars
2,176
Forks
249
Open Issues
47
Language
TypeScript
Default Branch
main
Sync Status
Idle
Last Synced
Apr 29, 2026, 02:04 PM
View on GitHub