Skip to content

ENG-9447: add agents md instructions#6461

Merged
adhami3310 merged 2 commits intomainfrom
khaleel/eng-9447-add-agent-skills-and-agentmdclaudemd-installation
May 5, 2026
Merged

ENG-9447: add agents md instructions#6461
adhami3310 merged 2 commits intomainfrom
khaleel/eng-9447-add-agent-skills-and-agentmdclaudemd-installation

Conversation

@adhami3310
Copy link
Copy Markdown
Member

No description provided.

@adhami3310 adhami3310 requested review from a team and Alek99 as code owners May 5, 2026 20:08
@linear
Copy link
Copy Markdown

linear Bot commented May 5, 2026

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

This PR adds a new documentation page explaining how to use AGENTS.md and CLAUDE.md project-level instruction files with Reflex, registers it in the docs sidebar under the existing Skills section, and extends the sidebar highlight logic to cover the new URL path.

  • New doc page (agents_md.md): covers installation via curl, sharing content with Claude Code using the @ import syntax, project-specific additions, keeping the template up to date, and combining with Skills/MCP.
  • Sidebar wiring (sidebar_items/ai.py, sidebar.py): adds AGENTS.md / CLAUDE.md as a SideBarItem under get_sidebar_items_skills and includes /ai/integrations/agents-md/ in is_ai_mcp_or_skills so active-state highlighting works correctly.

Confidence Score: 5/5

Documentation-only change with straightforward sidebar wiring; safe to merge.

All three changed files are docs content and UI navigation wiring with no runtime logic. The two observations are omissions in infrastructure files not touched by this PR and do not affect correctness of the delivered page.

docs/app/agent_files/_plugin.py (not changed here) — the new page will be absent from the llms.txt agent index until it is added to a doc-path inclusion set there.

Important Files Changed

Filename Overview
docs/ai_builder/integrations/agents_md.md New documentation page for AGENTS.md/CLAUDE.md conventions; content is accurate and well-structured.
docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/ai.py Adds a new SideBarItem for the agents_md page under the Skills section; change is minimal and follows existing patterns correctly.
docs/app/reflex_docs/templates/docpage/sidebar/sidebar.py Adds /ai/integrations/agents-md/ to the is_ai_mcp_or_skills path set so the sidebar highlight logic covers the new page; correctly follows the hyphenated URL convention.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["User visits /ai/integrations/agents-md/"] --> B["sidebar.py: is_ai_mcp_or_skills = True"]
    B --> C["sidebar_items/ai.py: Skills section rendered\nwith AGENTS.md / CLAUDE.md item highlighted"]
    C --> D["agents_md.md page content served"]
    D --> E["curl to AGENTS.md in project root"]
    D --> F["CLAUDE.md imports @AGENTS.md"]
    D --> G["Combining with Skills & MCP"]
    H["llms.txt generation (_plugin.py)"] -->|"agents-md.md not in SKILLS_DOC_PATHS"| I["⚠️ Page excluded from llms.txt"]
    H -->|"skills.md in SKILLS_DOC_PATHS"| J["✅ skills page included in llms.txt"]
Loading

Reviews (2): Last reviewed commit: "respond to greptile" | Re-trigger Greptile

Comment thread docs/ai_builder/integrations/agents_md.md Outdated
Comment thread docs/ai_builder/integrations/agents_md.md
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 5, 2026

Merging this PR will not alter performance

✅ 24 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing khaleel/eng-9447-add-agent-skills-and-agentmdclaudemd-installation (464ef82) with main (0487d9b)

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@adhami3310
Copy link
Copy Markdown
Member Author

@greptile

@adhami3310 adhami3310 merged commit 1ffc3b5 into main May 5, 2026
69 checks passed
@adhami3310 adhami3310 deleted the khaleel/eng-9447-add-agent-skills-and-agentmdclaudemd-installation branch May 5, 2026 22:08
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.

2 participants