Skip to content

Enable llms.txt documentation output - #19

Merged
timkpaine merged 1 commit into
mainfrom
tkp/llms-documentation
Oct 23, 2026
Merged

timkpaine merged 1 commit into
mainfrom
tkp/llms-documentation

Conversation

@timkpaine

Copy link
Copy Markdown
Member

Description

Enable Yardang's llms output for this project's documentation. Normal HTML builds will also publish llms.txt, llms-full.txt, and Markdown versions of reachable pages.

Verified a local docs build: 10 Markdown pages generated, and every local link in llms.txt resolves. Existing Markdown rendering limitations flatten file trees and emit Sphinx Design node warnings.

make lint, the test suite (93 passed), and python -m build passed. No new tests or version bump needed for this configuration change.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup
  • CI / build configuration
  • Other (describe below)

Checklist

  • Linting passes (make lint)
  • Tests pass (make test)
  • New tests added for new functionality
  • Documentation updated (if applicable)
  • Changelog / version bump (if applicable)

Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Test Results

93 tests  ±0   93 ✅ ±0   2s ⏱️ -1s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit 930a599. ± Comparison against base commit 018639f.

@codecov

codecov Bot commented Oct 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.51%. Comparing base (018639f) to head (930a599).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #19   +/-   ##
=======================================
  Coverage   93.51%   93.51%           
=======================================
  Files           6        6           
  Lines         540      540           
  Branches       68       68           
=======================================
  Hits          505      505           
  Misses         14       14           
  Partials       21       21           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@timkpaine
timkpaine merged commit 1e2579b into main Oct 23, 2026
4 checks passed
@timkpaine
timkpaine deleted the tkp/llms-documentation branch October 23, 2026 15:40
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.

1 participant