Repository navigation
Add automatic robot menu for LLM documentation - #20
Merged
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Enabling Yardang's llms output generates files without adding navigation links. Show a robot dropdown automatically when
yardang.sphinx.llmsis loaded, in the sidebar toolbar and mobile/notebook header. Offerllms.txtand, 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
Checklist
make lint)make test)