Skip to content

Add meta tags for docpages - #6464

Merged
FarhanAliRaza merged 6 commits into
mainfrom
carlos/meta-docs-updates
Jul 31, 2026
Merged

Add meta tags for docpages#6464
FarhanAliRaza merged 6 commits into
mainfrom
carlos/meta-docs-updates

Conversation

@carlosabadia

Copy link
Copy Markdown
Contributor

No description provided.

@carlosabadia
carlosabadia requested review from a team and Alek99 as code owners May 6, 2026 10:49
@carlosabadia carlosabadia added the documentation Improvements or additions to documentation label May 6, 2026
@codspeed-hq

codspeed-hq Bot commented May 6, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 26 untouched benchmarks
⏩ 8 skipped benchmarks1


Comparing carlos/meta-docs-updates (11a7bc8) with main (43b1e17)

Open in CodSpeed

Footnotes

  1. 8 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.

@greptile-apps

greptile-apps Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds per-document social-preview metadata support and centralizes public URL generation.

  • Extends parsed and serialized Markdown frontmatter with typed description and image fields.
  • Propagates frontmatter images through documentation routes into page metadata.
  • Adds a shared helper for composing deployment URLs and updates generated agent-file links to use it.
  • Adds focused tests for frontmatter metadata and URL composition.

Confidence Score: 5/5

The pull request appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
packages/reflex-docgen/src/reflex_docgen/markdown/_parser.py Parses description and image as reserved, typed frontmatter fields without treating them as component previews.
packages/reflex-docgen/src/reflex_docgen/markdown/_types.py Extends FrontMatter with backward-compatible optional description and image fields.
packages/reflex-docgen/src/reflex_docgen/markdown/transformer/_markdown.py Preserves populated description and image fields when serializing frontmatter.
docs/app/reflex_docs/pages/docs/init.py Caches frontmatter parsing and propagates per-page preview images into generated documentation routes.
docs/app/reflex_docs/reflex_docs.py Resolves each route's preview image with a default fallback before constructing page metadata.
packages/reflex-site-shared/src/reflex_site_shared/utils/url.py Centralizes deploy URL and frontend-path composition without retaining the previously reported hostname substring check.
docs/app/agent_files/_plugin.py Reuses the shared URL helper for generated Markdown assets and the documentation home link.

Reviews (4): Last reviewed commit: "Address review findings: guard frontmatt..." | Re-trigger Greptile

Comment thread packages/reflex-site-shared/src/reflex_site_shared/utils/url.py Outdated
Comment thread docs/app/reflex_docs/reflex_docs.py Outdated
…dates

# Conflicts:
#	docs/app/agent_files/_plugin.py
#	docs/app/reflex_docs/pages/docs/__init__.py
#	docs/app/reflex_docs/pages/docs/component.py
Comment thread packages/reflex-site-shared/src/reflex_site_shared/utils/url.py Outdated
Comment thread docs/app/agent_files/_plugin.py Outdated
FarhanAliRaza
FarhanAliRaza previously approved these changes May 22, 2026
…dates

# Conflicts:
#	docs/app/reflex_docs/pages/docs/__init__.py
#	docs/app/reflex_docs/pages/docs/component.py
#	docs/app/reflex_docs/reflex_docs.py
#	docs/app/reflex_docs/templates/docpage/docpage.py
#	packages/reflex-docgen/src/reflex_docgen/markdown/_parser.py
#	packages/reflex-docgen/src/reflex_docgen/markdown/_types.py
#	packages/reflex-docgen/src/reflex_docgen/markdown/transformer/_markdown.py
#	tests/units/docgen/test_markdown.py
@FarhanAliRaza FarhanAliRaza added the skip-changelog For doc/internal changes label Jul 31, 2026
The agent_files tests patched get_config only in agent_files._plugin, but
public URLs are now built via reflex_site_shared.utils.url.public_url which
reads the config through its own import; patch both read sites.

Add the towncrier news fragment for reflex-docgen's new frontmatter fields.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 12 files

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread packages/reflex-docgen/src/reflex_docgen/markdown/_parser.py
Comment thread docs/app/reflex_docs/pages/docs/__init__.py Outdated
Comment thread packages/reflex-site-shared/src/reflex_site_shared/utils/url.py Outdated
Comment thread docs/app/reflex_docs/pages/docs/__init__.py Outdated
- _frontmatter_for now tolerates read failures (returning None like docs
  without frontmatter) so an unreadable file can't abort route
  registration, and parses only the frontmatter block instead of the full
  document, keeping the per-doc startup cost minimal.
- public_url strips all trailing slashes from deploy_url instead of one.
- Regression tests for both.
@FarhanAliRaza
FarhanAliRaza merged commit fed170c into main Jul 31, 2026
109 checks passed
@FarhanAliRaza
FarhanAliRaza deleted the carlos/meta-docs-updates branch July 31, 2026 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skip-changelog For doc/internal changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants