wiki-llms-txt
llms.txt Generator
Generate llms.txt and llms-full.txt files that provide LLM-friendly access to wiki documentation, following the llms.txt specification.
When This Skill Activates
- User asks to generate
llms.txtor mentions the llms.txt standard - User wants to make documentation "LLM-friendly" or "LLM-readable"
- User asks for a project summary file for language models
- User mentions
llms-full.txtor context-expanded documentation
Source Repository Resolution (MUST DO FIRST)
Before generating, resolve the source repository context:
- Check for git remote: Run
git remote get-url origin - Ask the user: "Is this a local-only repository, or do you have a source repository URL?"
- Remote URL → store as
REPO_URL - Local → use relative paths only
- Remote URL → store as
- Determine default branch: Run
git rev-parse --abbrev-ref HEAD - Do NOT proceed until resolved
llms.txt Format (Spec-Compliant)
The file follows the llms.txt specification:
# {Project Name}
> {Dense one-paragraph summary — what it does, who it's for, key technologies}
{Important context paragraphs — constraints, architectural philosophy, non-obvious things}
## {Section Name}
- [{Page Title}]({relative-path-to-md}): {One-sentence description of what the reader will learn}
## Optional
- [{Page Title}]({relative-path-to-md}): {Description — these can be skipped for shorter context}
Key Rules
- H1 — Project name (exactly one, required)
- Blockquote — Dense, specific summary (required). Must be unique to THIS project.
- Context paragraphs — Non-obvious constraints, things LLMs would get wrong without being told
- H2 sections — Organized by topic, each with a list of
[Title](url): Descriptionentries - "Optional" H2 — Special meaning: links here can be skipped for shorter context
- Relative links — All paths relative to wiki directory
- Dynamic — ALL content derived from actual wiki pages, not templates
- Section order — Most important first: Onboarding → Architecture → Getting Started → Deep Dive → Optional
Description Quality
| ❌ Bad | ✅ Good |
|---|---|
| "Architecture overview" | "System architecture showing how Orleans grains communicate via message passing with at-least-once delivery" |
| "Getting started guide" | "Prerequisites, local dev setup with Docker Compose, and first API call walkthrough" |
| "The API reference" | "REST endpoints with auth requirements, rate limits, and request/response schemas" |
llms-full.txt Format
Same structure as llms.txt but with full content inlined:
# {Project Name}
> {Same summary}
{Same context}
## {Section Name}
<doc title="{Page Title}" path="{relative-path}">
{Full markdown content — frontmatter stripped, citations and diagrams preserved}
</doc>
Inlining Rules
- Strip YAML frontmatter (
---blocks) from each page - Preserve Mermaid diagrams — keep
```mermaidfences intact - Preserve citations — all
[file:line](URL)links stay as-is - Preserve tables — all markdown tables stay intact
- Preserve
<!-- Sources: -->comments — these provide diagram provenance
Prerequisites
This skill works best when wiki pages already exist (via /deep-wiki:generate or /deep-wiki:page). If no wiki exists yet:
- Suggest running
/deep-wiki:generatefirst - OR generate a minimal
llms.txtfrom README + source code scan (without wiki page links)
Output Files
Generate three files:
| File | Purpose | Discoverability |
|---|---|---|
./llms.txt |
Root discovery file | Standard path per llms.txt spec. GitHub MCP get_file_contents and search_code find this first. |
wiki/llms.txt |
Wiki-relative links | For VitePress deployment and wiki-internal navigation. |
wiki/llms-full.txt |
Full inlined content | Comprehensive reference for agents needing all docs in one file. |
The root ./llms.txt links into wiki/ (e.g., [Guide](./wiki/onboarding/contributor-guide.md)). The wiki/llms.txt uses wiki-relative paths (e.g., [Guide](./onboarding/contributor-guide.md)).
If a root llms.txt already exists and was NOT generated by deep-wiki, do NOT overwrite it.
Validation Checklist
Before finalizing:
- All linked files in
llms.txtactually exist - All
<doc>blocks inllms-full.txthave real content (not empty) - Blockquote is specific to this project (not generic boilerplate)
- Sections ordered by importance
- No duplicate page entries across sections
- "Optional" section only contains truly optional content
-
llms.txtis concise (1-5 KB) -
llms-full.txtcontains all wiki pages
More from linehaul-ai/linehaulai-claude-marketplace
geospatial-postgis-patterns
Implement geofences, spatial queries, real-time tracking, and mapping features in laneweaverTMS using PostGIS and PGRouting. Use when building location-based features, distance calculations, ETA predictions, or fleet visualization.
83quickbooks-online-api
Expert guide for QuickBooks Online API integration covering authentication, CRUD operations, batch processing, and best practices for invoicing, payments, and customer management.
61rbac-authorization-patterns
Provide patterns for implementing Role-Based Access Control and multi-tenant authorization in laneweaverTMS. Use when implementing user roles, permissions, tenant isolation, Echo authorization middleware, RLS policies for multi-tenant access, or JWT claims structure for freight brokerage applications.
61slack-block-kit
Build Slack Block Kit UIs for messages, modals, and Home tabs. Use when creating Slack notifications, interactive forms, bot responses, app dashboards, or any Slack UI. Covers blocks (Section, Actions, Input, Header), elements (Buttons, Selects, Date pickers), composition objects, and the slack-block-builder library.
44svelte-flow
Build node-based editors, interactive diagrams, and flow visualizations using Svelte Flow. Use when creating workflow editors, data flow diagrams, organizational charts, mindmaps, process visualizations, DAG editors, or any interactive node-graph UI. Supports custom nodes/edges, layouts (dagre, hierarchical), animations, and advanced features like proximity connect, floating edges, and contextual zoom.
35testcontainers-go
Use this skill when writing Go integration tests with Docker containers, using testcontainers-go modules (postgres, redis, kafka, etc.), setting up container-based test infrastructure, or configuring container networking and wait strategies. Covers 62+ pre-configured modules, cleanup patterns, and multi-container setups.
34