EPMRPP-114936 || Implement llms.txt#1115
Open
maria-hambardzumian wants to merge 5 commits into
Open
Conversation
maria-hambardzumian
requested review from
AmsterGet and
pressayuliya
as code owners
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughIntroduces an LLM documentation generator that scans the ChangesLLM Docs Generator
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/FAQ/test-llms.md (1)
1-10:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winPlease remove this temporary smoke-test page before merge.
The content explicitly marks itself as temporary; shipping it would add non-product FAQ noise.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/FAQ/test-llms.md` around lines 1 - 10, The file docs/FAQ/test-llms.md contains a temporary smoke-test page titled "llms.txt regeneration smoke test" that must be removed before merging; delete this file (or remove its temporary content and metadata) so the temporary FAQ entry and its frontmatter (title, description, sidebar_position) are not shipped in the product.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/gen-llms.yml:
- Around line 39-44: The run block that echoes the PR branch embeds `${{
github.event.pull_request.head.ref }}` directly into the shell, risking command
injection; change the step to assign `${{ github.event.pull_request.head.ref }}`
to an environment variable (e.g., PR_HEAD_REF) via the step's env: mapping and
then use that safe variable in the run script when writing to GITHUB_OUTPUT
(replace direct `${{ ... }}` usage with "$PR_HEAD_REF" in the echo to preserve
quoting and prevent shell metacharacter interpretation).
In `@scripts/gen-llms.js`:
- Around line 121-125: The current loadSections function skips pages with empty
page.sectionDir, and main only treats rootPage specially, which causes other
root-level docs to be omitted from llms.txt and ai-sitemap.json; update
loadSections and main so root-level pages (where page.sectionDir is falsy) are
collected (e.g., into a dedicated "root" section or appended to the top-level
list) except for the designated overview/rootPage, and ensure those collected
root entries are emitted into the llms.txt and ai-sitemap.json output generation
paths so all top-level docs are included. Use the loadSections function and the
main logic that references rootPage and page.sectionDir to locate where to add
this handling.
---
Outside diff comments:
In `@docs/FAQ/test-llms.md`:
- Around line 1-10: The file docs/FAQ/test-llms.md contains a temporary
smoke-test page titled "llms.txt regeneration smoke test" that must be removed
before merging; delete this file (or remove its temporary content and metadata)
so the temporary FAQ entry and its frontmatter (title, description,
sidebar_position) are not shipped in the product.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 858a5cad-cafd-4025-9a3a-dc1dc5fb68a6
📒 Files selected for processing (4)
.github/workflows/gen-llms.ymldocs/FAQ/test-llms.mdpackage.jsonscripts/gen-llms.js
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/gen-llms.yml:
- Around line 59-69: The workflow currently interpolates
steps.target.outputs.ref directly into the shell's git push invocation (git push
origin HEAD:${{ steps.target.outputs.ref }}), which allows a malicious ref to
inject shell commands; fix it by exporting the target ref into an environment
variable (e.g. TARGET_REF) from the job/step and then use a quoted refspec in
the push (git push origin "HEAD:${TARGET_REF}") so the value is not evaluated by
the shell; update the step that performs the push to reference the env var
(TARGET_REF or similar) and ensure it's quoted, and adjust any related uses of
steps.target.outputs.ref in this script to use the env variable instead.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9abc6ae9-fe82-4dc5-97e5-4313cda697a0
📒 Files selected for processing (4)
.github/workflows/gen-llms.ymldocs/FAQ/test-llms-second.mdstatic/ai-sitemap.jsonstatic/llms.txt
✅ Files skipped from review due to trivial changes (2)
- docs/FAQ/test-llms-second.md
- static/llms.txt
maria-hambardzumian
temporarily deployed
to
development
GitHub Actions
Inactive
maria-hambardzumian
temporarily deployed
to
development
GitHub Actions
Inactive
siarheirazuvalau
approved these changes
May 26, 2026
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
2 participants
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.
https://jiraeu.epam.com/browse/EPMRPP-114936
Summary by CodeRabbit
New Features
Chores