Skip to content

Add automatic robot menu for LLM documentation - #20

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

timkpaine merged 1 commit into
mainfrom
tkp/llms-navigation

Conversation

@timkpaine

Copy link
Copy Markdown
Member

Description

Enabling Yardang's llms output generates files without adding navigation links. Show a robot dropdown automatically when yardang.sphinx.llms is loaded, in the sidebar toolbar and mobile/notebook header. Offer llms.txt and, when enabled, llms-full.txt, with links resolved relative to each page.

The native dropdown works without JavaScript. JavaScript adds Escape and outside-click dismissal, returning focus to the button on Escape. Add integration tests and document the automatic menu; Yardang is a development dependency for the tests.

Validated with 102 passing tests, make lint, python -m build, and wheel/sdist contents. Built Yardang's full documentation with existing warnings. Chromium checks covered desktop and mobile, nested-page links returning HTTP 200, keyboard navigation, Escape, outside clicks, and use without JavaScript.

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

102 tests  +9   102 ✅ +9   2s ⏱️ ±0s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit ec58e05. ± Comparison against base commit 1e2579b.

@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.95%. Comparing base (1e2579b) to head (ec58e05).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #20      +/-   ##
==========================================
+ Coverage   93.51%   93.95%   +0.43%     
==========================================
  Files           6        7       +1     
  Lines         540      579      +39     
  Branches       68       71       +3     
==========================================
+ Hits          505      544      +39     
  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 aff71fa into main Oct 23, 2026
4 checks passed
@timkpaine
timkpaine deleted the tkp/llms-navigation branch October 23, 2026 16:22
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