-
Notifications
You must be signed in to change notification settings - Fork 229
ENG-7382: update to best practice docs #1586
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 enhances the formatting and readability of the AI Builder best practices documentation (docs/ai_builder/overview/best_practices.md). The changes focus on improving visual hierarchy and consistency throughout the document without altering the actual content or guidance.
Key formatting improvements include:
- Converting italic quoted examples to bold formatting to make actionable prompts more prominent
- Restructuring bullet points with proper indentation for better scannability
- Replacing plain quoted examples with diff code blocks that clearly show before/after comparisons
- Standardizing how examples and prompts are presented throughout the document
These changes align with modern documentation best practices where visual formatting helps users quickly distinguish between actionable content and explanatory text. The AI Builder documentation is part of Reflex's AI-powered app building feature, and clear best practice guidance is crucial for users to effectively leverage the AI capabilities. The enhanced formatting will make it easier for developers to scan the document and identify key recommendations when working with the AI Builder.
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it only involves documentation formatting changes
- Score reflects that this is purely a visual formatting improvement with no functional code changes or potential breaking issues
- No files require special attention as the changes are straightforward formatting improvements to documentation
1 file reviewed, no comments
* 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.