improve-select-docs

Author: Tom Gotsman

docs/app/.python-version

@@ -0,0 +1 @@
+3.13

docs/app/agent_files/_plugin.py

@@ -9,11 +9,13 @@
 def generate_markdown_files() -> tuple[tuple[Path, str | bytes], ...]:
     from reflex_docs.pages.docs import doc_markdown_sources
 
-    return tuple([
-        (PosixPath(route.strip("/") + ".md"), resolved.read_bytes())
-        for route, source_path in doc_markdown_sources.items()
-        if (resolved := Path(source_path)).is_file()
-    ])
+    return tuple(
+        [
+            (PosixPath(route.strip("/") + ".md"), resolved.read_bytes())
+            for route, source_path in doc_markdown_sources.items()
+            if (resolved := Path(source_path)).is_file()
+        ]
+    )
 
 
 def generate_llms_txt(

docs/app/reflex_docs/pages/docs/__init__.py

@@ -11,7 +11,13 @@
 from reflex_site_shared.route import Route
 
 from reflex_docs.docgen_pipeline import get_docgen_toc, render_docgen_document
-from reflex_docs.pages.docs.component import multi_docs
+from reflex_docs.pages.docs.component import (
+    get_related_from_frontmatter,
+    get_seo_from_frontmatter,
+    multi_docs,
+    related_links_footer,
+    seo_kwargs,
+)
 from reflex_docs.pages.library_previews import components_previews_pages
 from reflex_docs.templates.docpage import docpage
 from reflex_docs.whitelist import _check_whitelisted_path
@@ -182,13 +188,21 @@ def resolve_doc_route(doc: str, title: str) -> ResolvedDoc | None:
     return ResolvedDoc(route=route, display_title=display_title, category=category)
 
 
-def make_docpage(route: str, title: str, doc_virtual: str, render_fn):
-    """Wrap a render function as a docpage, setting module metadata."""
+def make_docpage(route: str, title: str, doc_virtual: str, render_fn, **docpage_kwargs):
+    """Wrap a render function as a docpage, setting module metadata.
+
+    Args:
+        route: The site route for this page.
+        title: The page title.
+        doc_virtual: The virtual path used for module metadata.
+        render_fn: The function that returns the page component.
+        **docpage_kwargs: Extra keyword args forwarded to ``docpage`` (SEO, etc.).
+    """
     doc_path = Path(doc_virtual)
     render_fn.__module__ = ".".join(doc_path.parts[:-1])
     render_fn.__name__ = doc_path.stem
     render_fn.__qualname__ = doc_path.stem
-    return docpage(set_path=route, t=title)(render_fn)
+    return docpage(set_path=route, t=title, **docpage_kwargs)(render_fn)
 
 
 def handle_library_doc(
@@ -223,15 +237,27 @@ def get_component_docgen(virtual_doc: str, actual_path: str, title: str):
     if virtual_doc.startswith("docs/library"):
         return handle_library_doc(virtual_doc, actual_path, title, resolved)
 
-    def comp(_actual=actual_path, _virtual=virtual_doc):
+    seo = get_seo_from_frontmatter(actual_path)
+    related = get_related_from_frontmatter(actual_path)
+    seo_extras = seo_kwargs(seo, resolved.display_title, resolved.route)
+
+    def comp(_actual=actual_path, _virtual=virtual_doc, _related=related):
         toc = get_docgen_toc(_actual)
         doc_content = Path(_actual).read_text(encoding="utf-8")
         rendered = render_docgen_document(
             virtual_filepath=_virtual, actual_filepath=_actual
         )
-        return ((toc, doc_content), rendered)
+        footer = related_links_footer(_related)
+        body = (
+            rx.box(rendered, footer, class_name="flex flex-col w-full")
+            if _related is not None
+            else rendered
+        )
+        return ((toc, doc_content), body)
 
-    return make_docpage(resolved.route, resolved.display_title, virtual_doc, comp)
+    return make_docpage(
+        resolved.route, resolved.display_title, virtual_doc, comp, **seo_extras
+    )
 
 
 # Build doc_markdown_sources mapping

docs/app/reflex_docs/pages/docs/cloud_cliref.py

@@ -177,74 +177,83 @@ def process(
     """Convert a Click command to a Markdown element."""
     actual_name = override_name or command["name"]
     full_name = prefix + " " + actual_name if prefix and actual_name else actual_name
-    cli_to_doc[full_name] = Section((
-        Paragraph(InlineText(command["help"])) if command["help"] else Empty(),
-        Section((
-            Header(3, InlineText("Usage")),
-            CodeBlock(
-                "$"
-                + (" " + prefix.strip() if prefix else "")
-                + " "
-                + actual_name.strip()
-                + (
-                    " [OPTIONS]"
-                    if command["params"]
-                    and any(
-                        param.get("param_type_name") != "argument"
-                        for param in command["params"]
-                    )
-                    else ""
-                )
-                + (
-                    " " + " ".join(arguments)
-                    if (
-                        arguments := [
-                            param["name"].upper()
-                            for param in command["params"]
-                            if param.get("param_type_name") == "argument"
-                            and param["name"]
-                        ]
-                    )
-                    else ""
-                ),
-                language="console",
-            ),
-        ))
-        if actual_name
-        else Empty(),
-        Section((
-            Header(3, InlineText("Options")),
-            List(
-                tuple(
-                    InlineTextCollection((
-                        InlineCode(
-                            ", ".join(param["opts"])
-                            + (
-                                " / " + ", ".join(param["secondary_opts"])
-                                if param["secondary_opts"]
-                                else ""
+    cli_to_doc[full_name] = Section(
+        (
+            Paragraph(InlineText(command["help"])) if command["help"] else Empty(),
+            Section(
+                (
+                    Header(3, InlineText("Usage")),
+                    CodeBlock(
+                        "$"
+                        + (" " + prefix.strip() if prefix else "")
+                        + " "
+                        + actual_name.strip()
+                        + (
+                            " [OPTIONS]"
+                            if command["params"]
+                            and any(
+                                param.get("param_type_name") != "argument"
+                                for param in command["params"]
                             )
-                            + (
+                            else ""
+                        )
+                        + (
+                            " " + " ".join(arguments)
+                            if (
+                                arguments := [
+                                    param["name"].upper()
+                                    for param in command["params"]
+                                    if param.get("param_type_name") == "argument"
+                                    and param["name"]
+                                ]
+                            )
+                            else ""
+                        ),
+                        language="console",
+                    ),
+                )
+            )
+            if actual_name
+            else Empty(),
+            Section(
+                (
+                    Header(3, InlineText("Options")),
+                    List(
+                        tuple(
+                            InlineTextCollection(
                                 (
-                                    " " + param["type"]["name"].upper()
-                                    if param["type"]["name"] != "boolean"
-                                    else ""
+                                    InlineCode(
+                                        ", ".join(param["opts"])
+                                        + (
+                                            " / " + ", ".join(param["secondary_opts"])
+                                            if param["secondary_opts"]
+                                            else ""
+                                        )
+                                        + (
+                                            (
+                                                " " + param["type"]["name"].upper()
+                                                if param["type"]["name"] != "boolean"
+                                                else ""
+                                            )
+                                            if (choices := param["type"].get("choices"))
+                                            is None
+                                            else " [" + "|".join(choices) + "]"
+                                        )
+                                    ),
+                                    InlineText(": " + option_help),
                                 )
-                                if (choices := param["type"].get("choices")) is None
-                                else " [" + "|".join(choices) + "]"
                             )
+                            for param in command["params"]
+                            if (option_help := param.get("help")) is not None
                         ),
-                        InlineText(": " + option_help),
-                    ))
-                    for param in command["params"]
-                    if (option_help := param.get("help")) is not None
-                ),
-                ordered=False,
-            ),
-        ))
-        if command["params"]
-        else Empty(),
-    )).into_text()
+                        ordered=False,
+                    ),
+                )
+            )
+            if command["params"]
+            else Empty(),
+        )
+    ).into_text()
     for name, sub_command in sort_subcommands(command.get("commands", {})).items():
         process(
             sub_command,