Add meta tags for docpages

[carlosabadia]

No description provided.

[codspeed-hq]

Merging this PR will not alter performance

✅ 24 untouched benchmarks

---

_{Comparing carlos/meta-docs-updates (293ceef) with main (6bb44d5)}

[greptile-apps]

Greptile Summary

This PR adds per-page SEO meta tags (og:*, twitter:*, canonical URL) to doc pages by extending the FrontMatter type with optional description and image fields, threading them through the docpage template and multi_docs helper, and wiring them into app.add_page in reflex_docs.py. It also extracts the deploy_url + frontend_path URL-building logic into a new shared public_url utility, replacing three near-identical inline implementations.

• Frontmatter layer: FrontMatter gains description and image fields; the parser, transformer, and tests are all updated in sync with good round-trip coverage.
• Template layer: docpage() and multi_docs() accept and forward the new fields to Route; title-resolution logic in docpage is simplified by removing a duplicated branch.
• App layer: reflex_docs.py builds a deduped meta-tag list per route (stripping tags Reflex already emits via add_page) and generates canonical URLs via the new public_url helper with a DOCS_PROD_BASE fallback for non-production environments.

Confidence Score: 4/5

Safe to merge; the changes are build-time only and do not affect request handling or data storage.

The implementation is clean end-to-end and well-tested. The two observations are both minor: the "localhost" in deploy_url substring check in public_url can activate the fallback on non-local hostnames that happen to contain "localhost", and the meta-tag deduplication in _seo_meta_tags silently relies on which tags Reflex emits internally — a relationship that isn't documented and could drift with a Reflex upgrade.

packages/reflex-site-shared/src/reflex_site_shared/utils/url.py (localhost check) and docs/app/reflex_docs/reflex_docs.py (_seo_meta_tags deduplication assumptions).

Important Files Changed

Filename	Overview
packages/reflex-site-shared/src/reflex_site_shared/utils/url.py	New shared utility centralizing deploy_url + frontend_path URL construction; the localhost detection uses a substring match that could activate the fallback on non-local hostnames.
docs/app/reflex_docs/reflex_docs.py	Adds per-page SEO meta tags (OG, Twitter, canonical) with a deduplication filter against Reflex's built-in tag emission; filter assumptions are implicit and could drift with Reflex upgrades.
docs/app/reflex_docs/pages/docs/init.py	Adds description/image extraction from frontmatter with lru_cache on the parse step; wires both into make_docpage and handle_library_doc cleanly.
packages/reflex-docgen/src/reflex_docgen/markdown/_types.py	FrontMatter dataclass extended with optional description and image fields (both defaulting to None); valid ordering with non-default fields first.
packages/reflex-docgen/src/reflex_docgen/markdown/_parser.py	Parses description and image keys from YAML frontmatter; both reserved in _KNOWN_KEYS so they're excluded from component preview processing.
docs/app/reflex_docs/templates/docpage/docpage.py	docpage() gains description and image params that are forwarded to the Route; title resolution refactored to eliminate duplicated branch logic.
tests/units/docgen/test_markdown.py	Good test coverage for the new fields: parse round-trip, default-None behavior, reserved-key isolation, and transformer emission/omission.
docs/app/reflex_docs/pages/docs/component.py	multi_docs passes description and image through to both the main and low-level docpage decorators.
docs/app/agent_files/_plugin.py	Replaces inline deploy_url/frontend_path construction with the new public_url helper; logic is equivalent and more concise.
packages/reflex-docgen/src/reflex_docgen/markdown/transformer/_markdown.py	Transformer emits description and image into the YAML block only when set, consistent with how title is handled.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    FM[Markdown Frontmatter
description / image] --> P[_parser.py
_extract_frontmatter]
    P --> FMT[FrontMatter dataclass
+ description + image]
    FMT --> Cache[_frontmatter_for
lru_cache]
    Cache --> GD[get_description_from_frontmatter]
    Cache --> GI[get_image_from_frontmatter]
    GD --> MDP[make_docpage / multi_docs]
    GI --> MDP
    MDP --> DP[docpage decorator
description + image]
    DP --> Route[Route
path / title / description / image]
    Route --> RD[reflex_docs.py loop]
    RD --> CDN[to_cdn_image_url]
    RD --> PU[public_url
canonical URL]
    CDN --> SEO[_seo_meta_tags
create_meta_tags - deduped]
    PU --> SEO
    SEO --> AP[app.add_page
meta list]
    Route --> AP

Loading

_{Reviews (1): Last reviewed commit: "Add meta tags for docpages" | Re-trigger Greptile}

[FarhanAliRaza]

we might be able to use is_prod_mode here. Now we are doing a simple string check that can fail.
from reflex.utils.exec import is_prod_mode and also move the get_config import on top.

from reflex.utils.exec import is_prod_mode
from reflex_base.config import get_config

def public_url(path: str = "", fallback_base: str | None = None) -> str:
      if fallback_base is not None and not is_prod_mode():
          return fallback_base.rstrip("/") + path

      config = get_config()
      deploy_url = (config.deploy_url or "").removesuffix("/")
      frontend_path = (config.frontend_path or "").strip("/")
      if frontend_path:
          base = f"{deploy_url}/{frontend_path}" if deploy_url else f"/{frontend_path}"
      else:
          base = deploy_url
      return f"{base}{path}" if base else path

[FarhanAliRaza]

we also might wan to move this to top. and same in _docs_home_url