Repository navigation
Conversation
Fix RB-047: Docs pages served as .md files (e.g., /docs/getting-started/introduction.md) contained broken localhost:3000 links in their banners, which are broken for external readers like AI agents, crawlers, and ChatGPT. Changed the markdown directive banner to use hardcoded production URLs (https://reflex.dev/docs/index.md) instead of config-dependent localhost URLs. This ensures AI agents and search engines accessing the .md files see working links to the documentation home and index. Co-authored-by: Alek Petuskey <Alek99@users.noreply.github.com>
Co-authored-by: Alek Petuskey <Alek99@users.noreply.github.com>
Contributor
[Low impact] The PR appears safe to merge. SummaryChanges the Markdown banner’s docs-home link to
Reviews (1) · Last reviewed commit: "Add news fragment for RB-047 fix" · Reviewed by Greptile |
Merging this PR will not alter performance
|
This branch has not been deployed
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.
Type of change
Description
This PR fixes RB-047 by replacing broken localhost:3000 links in markdown documentation files (.md copies) with production URLs.
Problem: Documentation pages served as
.mdfiles (e.g.,https://reflex.dev/docs/getting-started/introduction.md) contained brokenlocalhost:3000links in their banners. These links were broken for external readers like AI agents, search engine crawlers, and ChatGPT, negatively impacting SEO and AEO (AI Engine Optimization).Example of the broken banner:
Solution: Changed the markdown directive banner to use hardcoded production URLs (
https://reflex.dev/docs/index.md) instead of config-dependent localhost URLs. This is consistent with howPUBLIC_LLMS_TXT_URLis already handled.Changes:
PUBLIC_DOCS_HOME_MARKDOWN_URLconstant pointing to production URL_markdown_directive()to use the new constant instead ofpublic_url("/index.md")Impact
This is a template-level one-line fix that applies to all generated
.mddocumentation files. No individual doc pages were modified.Testing
ruff checkandruff format)References
Fixes RB-047