Skip to content

Fix broken docs links and updates for agents#6420

Merged
Alek99 merged 3 commits intomainfrom
carlos/agents-score-fixes
Apr 29, 2026
Merged

Fix broken docs links and updates for agents#6420
Alek99 merged 3 commits intomainfrom
carlos/agents-score-fixes

Conversation

@carlosabadia
Copy link
Copy Markdown
Contributor

No description provided.

@carlosabadia carlosabadia requested review from a team and Alek99 as code owners April 29, 2026 14:20
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 29, 2026

Merging this PR will not alter performance

✅ 9 untouched benchmarks


Comparing carlos/agents-score-fixes (527e3b9) with main (8f7ad9a)

Open in CodSpeed

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 29, 2026

Greptile Summary

This PR fixes ~25 broken internal documentation links by converting underscore-separated URL paths to kebab-case, and extends the agent-facing docs pipeline in _plugin.py with dynamic API reference markdown generation (class docs, environment variables) plus a MARKDOWN_DIRECTIVE banner prepended to every generated markdown asset. The per-page sr-only llms.txt directive is consolidated into a single app-level component in reflex_docs.py.

Confidence Score: 4/5

Safe to merge — changes are doc link fixes and non-breaking additive agent tooling with good test coverage.

All P2 findings only. The link fixes are mechanical and well-tested. The new dynamic API reference generation is additive, isolated to the agent plugin, and covered by new tests. One stale type annotation (str | bytes → str) is the only notable inconsistency.

docs/app/agent_files/_plugin.py — stale return type annotation on generate_markdown_files

Important Files Changed

Filename Overview
docs/app/agent_files/_plugin.py Major addition: new MarkdownIndexEntry dataclass, dynamic API reference markdown generation, MARKDOWN_DIRECTIVE constant, and _strip_markdown_directive helper. generate_markdown_files return type annotation (str
docs/app/reflex_docs/reflex_docs.py Moves LLMS_TXT_PATH constant here and renders _llms_txt_directive() once at app level as a screen-reader-only blockquote child of rx.theme().
docs/app/reflex_docs/templates/docpage/docpage.py Removes LLMS_TXT_PATH constant and per-page blockquote directive; the directive is now rendered once at the app level.
docs/app/tests/test_agent_files.py Test suite updated to use MarkdownIndexEntry; new tests for generate_markdown_file_content, generate_dynamic_api_reference_files, and dynamic markdown stitching.
docs/enterprise/ag_grid/index.md Formatting cleanups and a fix for a nested code block inside an md alert info directive that was missing its own closing fence.
docs/getting_started/basics.md Multiple internal links updated from underscore-separated paths to kebab-case.
docs/advanced_onboarding/how-reflex-works.md Two broken links fixed: background_events → background-events, yield_events → yield-events.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[generate_agent_files] --> B[generate_markdown_file_entries]
    A --> C[generate_dynamic_api_reference_files]
    B --> D[generate_markdown_file_content\nAdds MARKDOWN_DIRECTIVE prefix]
    C --> E[generate_class_api_reference_markdown\nfor each class/module]
    C --> F[generate_environment_variables_markdown]
    B --> G[MarkdownIndexEntry conversion]
    C --> H[dynamic_api_reference_index_entries]
    G --> I[generate_llms_txt\nMarkdownIndexEntry list]
    H --> I
    D --> J[Return: static markdown files]
    E --> K[Return: dynamic API reference files]
    F --> K
    K --> L[generate_llms_full_txt\nstatic + dynamic content]
    I --> M[llms.txt index]
    L --> N[llms-full.txt]
Loading

Reviews (1): Last reviewed commit: "Fix broken docs links and updates for ag..." | Re-trigger Greptile

Comment thread docs/app/agent_files/_plugin.py Outdated
Comment thread docs/app/agent_files/_plugin.py
@Alek99 Alek99 self-requested a review April 29, 2026 18:28
@Alek99 Alek99 merged commit e422b1a into main Apr 29, 2026
68 of 69 checks passed
@Alek99 Alek99 deleted the carlos/agents-score-fixes branch April 29, 2026 18:28
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