-
Notifications
You must be signed in to change notification settings - Fork 229
ENG-7585: docs patch (+ ENG-7581) #1611
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR implements a comprehensive documentation and navigation cleanup for the Reflex web repository, focusing primarily on the AI Builder documentation section. The changes span multiple areas:
Documentation Content Updates: The PR updates AI Builder documentation by removing 'API' from integration examples in interaction modes, updating an embedded YouTube video to showcase newer IDE features, and removing a 'Common Use Cases' section from the general app lifecycle documentation to streamline content focus.
Navigation Infrastructure Improvements: Several navigation-related changes improve consistency and user experience. The sidebar item formatting logic now properly capitalizes 'MCP' (Model Context Protocol) acronyms alongside existing acronym formatting for API, CLI, AI, and IDE. The navbar's AI Builder link now directs users to the 'best practices' page instead of 'what is reflex build', suggesting a shift toward more actionable entry points.
State Management and Routing Fixes: The PR addresses navigation state management issues by modifying how sidebar navigation works. The sidebar category function now uses a standardized JavaScript redirect pattern (href='#' with on_click events) instead of direct href navigation, ensuring proper state updates before navigation occurs. Additionally, caching was removed from the sidebar_index computed property to ensure real-time responsiveness to URL changes, fixing potential issues where the active sidebar section wouldn't update correctly during navigation.
Path Management: Hardcoded URL paths are replaced with dynamic path references from imported modules, improving maintainability and reducing the risk of broken links when routes change.
These changes collectively improve the documentation structure, fix navigation bugs, and establish more consistent patterns across the codebase while maintaining the existing functionality.
Confidence score: 4/5
- This PR is generally safe to merge with minimal risk, consisting primarily of documentation updates and navigation improvements
- Score reflects that while most changes are low-risk documentation updates, the navigation state management changes could potentially affect user experience if not properly tested
- Pay close attention to the sidebar state management changes in
pcweb/components/docpage/sidebar/state.pyandpcweb/components/docpage/sidebar/sidebar.pyto ensure navigation works correctly across all documentation sections
7 files reviewed, no comments
* refine ai docs * Reflex Build IDE vid * refine interaction mode docs * patches to navbar, sidebar, and others * add link with url * make set sidebar index event temporal --------- Co-authored-by: carlosabadia <[email protected]>
* ENG-7370: Bring back prompt box * updates * fix redirect * add min prompt length * Update Local Component section of Wrapping React (#1584) * Fix the existing broken example due to using JSX syntax in a JS file. * Add more explanation about using rx.asset * Add example of including CSS import * Add important consideration and usecase bullets * update to best practice docs (#1586) * streamlit reflex blog (#1540) * streamlit reflex blog * small fix * add new image --------- Co-authored-by: Tom Gotsman <[email protected]> Co-authored-by: Alek Petuskey <[email protected]> * update cloud hosting (#1588) * ENG-7438: Fix small icons on what is reflex build page (#1590) * ENG-7375: AI builder nav item + bump (#1589) * ENG-7375: AI builder nav item + bump * update * ENG-7443: make DOCS badge responsive (#1591) * make DOCS badge responsive * center logo + badge * move all contact sales links to pricing (#1595) * move all contact sales links to pricing * update * + new templates (#1593) * Update ‘Apps built with Reflex’ stat from 100K+ to 300K+ (#1596) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Alek <[email protected]> * Update affiliate partner booking links to lemcal.com (#1597) - Update both 'Become a Partner' buttons to use https://app.lemcal.com/@alek/reflex-demo?back=1 - Replace old Cal.com form URLs with new lemcal.com booking URL - Maintains existing functionality while updating to new booking system Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Alek <[email protected]> * ENG-7440: update ai docs (+ ENG-7383) (#1592) * update ai docs * more ai-related docs * + ai docs * Update docs/ai_builder/features/code_editor.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update docs/ai_builder/app_lifecycle/copy_app.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update docs/ai_builder/app_lifecycle/general.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update docs/ai_builder/integrations/databricks.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * updates part I * update part II --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * add input types for better use (#1598) * add demo url for AG Grid (#1599) * fix affiliate link (#1602) Co-authored-by: Tom Gotsman <[email protected]> * ENG-7498: Blog (From Jupyter Notebook to Production Dashboard) (#1600) * blog * add thumbnail to blog * remove pro and team tier mentions (#1603) * ENG-7542: new blog + prev. blog image fix (#1604) * new blog + prev. blog image fix * Update blog/2025-09-02-reflex-build.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * use .path for URL --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * update deploy strategy (#1607) * Revert "ENG-7498: Blog (From Jupyter Notebook to Production Dashboard) (#1600)" (#1608) This reverts commit f1ad749. * Revert "ENG-7542: new blog + prev. blog image fix (#1604)" (#1609) This reverts commit 56c1a14. * ENG-7551: add booked page (#1606) * add booked page * second page * updates * add url * ENG-7585: docs patch (+ ENG-7581) (#1611) * refine ai docs * Reflex Build IDE vid * refine interaction mode docs * patches to navbar, sidebar, and others * add link with url * make set sidebar index event temporal --------- Co-authored-by: carlosabadia <[email protected]> * add watch preview button * update video url --------- Co-authored-by: Kastier1 <[email protected]> Co-authored-by: Masen Furer <[email protected]> Co-authored-by: Ahmad Hakim <[email protected]> Co-authored-by: Tom Gotsman <[email protected]> Co-authored-by: Tom Gotsman <[email protected]> Co-authored-by: Alek Petuskey <[email protected]> Co-authored-by: Mohamed Otefi <[email protected]> Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Alek <[email protected]> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
No description provided.