Skip to content

Configure Astro Starlight with starlight-llms-txt extension#756

Merged
pelikhan merged 2 commits intomainfrom
copilot/fix-9242d27f-a684-44f2-b581-80f7a4c97ea1
Sep 12, 2025
Merged

Configure Astro Starlight with starlight-llms-txt extension#756
pelikhan merged 2 commits intomainfrom
copilot/fix-9242d27f-a684-44f2-b581-80f7a4c97ea1

Conversation

Copy link
Contributor

Copilot AI commented Sep 12, 2025

This PR configures the starlight-llms-txt extension for the GitHub Agentic Workflows documentation site to automatically generate llms.txt files that provide structured documentation content for LLM training and context.

What this adds

The starlight-llms-txt extension automatically generates three types of llms.txt files from the existing Starlight documentation:

  • /llms.txt (957 bytes) - Main index file with documentation structure and links
  • /llms-small.txt (134K) - Abridged documentation optimized for efficient LLM context
  • /llms-full.txt (140K) - Complete documentation for comprehensive LLM training

Changes made

  1. Installed starlight-llms-txt package in the docs directory
  2. Updated astro.config.mjs to:
    • Import and configure the starlight-llms-txt plugin
    • Add the required site URL (https://githubnext.github.io/gh-aw/)
    • Configure with project-specific description and helpful optional links

Configuration details

The extension is configured with:

  • Custom description: Explains that gh-aw is a Go-based GitHub CLI extension for writing agentic workflows in markdown
  • Optional links: Points to the GitHub repository and GitHub CLI documentation for additional context
  • Automatic processing: All 16 documentation pages are processed during build

Benefits

  • AI accessibility: Makes documentation easily consumable by LLMs and AI systems
  • Multiple formats: Provides both compact and comprehensive versions for different use cases
  • Build integration: Files are automatically generated and updated when documentation changes
  • Standard compliance: Follows the llms.txt specification for structured AI training data

The generated files enable AI systems to better understand and work with GitHub Agentic Workflows by providing well-structured, comprehensive documentation in formats optimized for LLM consumption.

![Starlight Documentation Homepage](https://github.com/user-attachments/assets/982e50b5-e91a-4a60-97d9-5b1912d61db9)

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)
    • Triggering command: node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Configure Astro starlight with the https://github.com/delucis/starlight-llms-txt extension Configure Astro Starlight with starlight-llms-txt extension Sep 12, 2025
Copilot AI requested a review from pelikhan September 12, 2025 01:05
@pelikhan pelikhan marked this pull request as ready for review September 12, 2025 02:53
@pelikhan pelikhan merged commit 5c60a62 into main Sep 12, 2025
11 checks passed
@pelikhan pelikhan deleted the copilot/fix-9242d27f-a684-44f2-b581-80f7a4c97ea1 branch September 12, 2025 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants