Repository navigation
docs: sync llms.txt with Sphinx toctrees - #349
Conversation
Add the missing event-handling, utils, changelog, and Bot API pages to docs/_extra/llms.txt so LLM crawlers see the same map as index.rst. Add a regression test that fails if a toctree page is omitted. Fixes K1rL3s#267
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughОбновлён ChangesСинхронизация документации
Priority: ➖ Normal Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other · Severity of issue fixed: Medium Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation map covers the inspected Sphinx pages, so the change is mergeable. 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
Full details: Linked Issues checkExplanation По Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: a8ddf676-d063-4dc9-b8e9-6f9d67a70553
📒 Files selected for processing (2)
docs/_extra/llms.txttests/test_llms_txt.py
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.
Проверку полноты llms.txt решили не автоматизировать: файл остаётся рукописной аннотированной картой документации, за его полнотой следит ревью. Три описания приведены к тому, что на страницах есть: в быстром старте нет таба с вебхуком, флаги ставятся не только декоратором, но и при регистрации хендлера и фильтрами, а link.rst - про сборку ссылок max:// и https://max.ru и перевод ID сообщения в ссылку и обратно.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #349 +/- ##
=======================================
Coverage 98.68% 98.68%
=======================================
Files 417 417
Lines 12200 12200
=======================================
Hits 12039 12039
Misses 161 161 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
2 participants
Summary
docs/_extra/llms.txtno longer omitted pages that already appear in the Sphinx toctrees.Closes #267
Motivation
Issue #267 listed pages present in
docs/index.rst(and the hidden Bot API toctree) but missing fromllms.txt, so LLM crawlers and Context7/DeepWiki saw an incomplete docs map.Implementation
docs/_extra/llms.txt:pages/event-handling/flagspages/utils/link,callback_answer,chat_actionpages/changelogbot,types,methods,enums,updatestests/test_llms_txt.pyso a future toctree entry without a matchingllms.txtURL fails CI.Did not generate
llms.txtfrom Sphinx inconf.py, because the file is meant to stay a short annotated map rather than a dump of every title.Testing
Result:
1 passed.Summary by CodeRabbit