FlexiRule Source-Grounded Documentation Overhaul - #92
Conversation
- Overhauled Homepage (_index.md) with Hook Hell problem definition, visual model flow, real-world example, and navigation paths. - Updated Smart Value System documentation to detail all 12 canonical user-facing Value Resolvers verified from source code. - Standardized all Core Action Guides to follow 6-section template format. - Added step-by-step ERPNext business recipes in tutorials/. - Updated developer architecture and resolver class hierarchy references. - Generated audit report at reports/documentation_improvement_report.md summarizing source commit 279f576d376bba45a6367a03955a6a4d83019ee6.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 37199cf297
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| # Welcome to FlexiRule | ||
|
|
||
| FlexiRule is a high-performance, visual automation engine for the Frappe Framework. It allows you to design, execute, and manage complex business logic without writing boilerplate code. | ||
| **FlexiRule** is a high-performance, visual logic engineering and orchestration engine for the Frappe Framework and ERPNext. It allows business analysts, ERP consultants, and developers to design, execute, and manage complex business logic without writing scattered Python code. |
There was a problem hiding this comment.
layouts/index.html is the template selected for the site home page, but it never renders .Content. Consequently, the newly added overview, execution pipeline, credit-limit example, and documentation cards in this file are omitted from the deployed / page, which continues to show the pre-existing hard-coded homepage copy. Render the page content from the home template or move this overhaul into that template.
Useful? React with 👍 / 👎.
|
|
||
| <div class="grid-2"> | ||
|
|
||
| {{< card title="Validate & Block Submission" link="/tutorials/validate-and-block-document/" icon="warning" >}} |
There was a problem hiding this comment.
The card shortcode reads only .Get "href" in layouts/shortcodes/card.html, so these link= parameters fall back to its default #. Every newly added card on this tutorials index therefore leaves the reader on the same page instead of opening its recipe; use href= here (or make the shortcode accept link).
Useful? React with 👍 / 👎.
| 5. Open the **Rule Builder**. | ||
|
|
||
| ### Step 2: Add the Repeat (Loop) Node |
There was a problem hiding this comment.
For any row whose item group is not Electronics, this Check's False port is left unconnected; only the True path reaches the Set Value node that loops back. That causes execution to end at the first nonmatching row, so later eligible items and the Repeat exit branch are never reached in mixed-item orders. Connect the False path back to Repeat as well.
Useful? React with 👍 / 👎.
Updated content/en/_index.md to feature a prominent quick-start learning sequence leading directly from Getting Started (Quick Start Guide) to Introduction & Core Concepts.
Updated all tutorials and quick start guides to use UI-first instructions (what to click, how to use the Smart Value Selector with `@` and `/` popups, and field picker menus) instead of raw expression syntax.
Updated layouts/shortcodes/card.html to evaluate `$link | relURL` (supporting both `href` and `link` attributes) ensuring navigation cards resolve correctly on GitHub Pages under the /flexirule-docs/ base path.
Updated layouts/index.html to point the hero 'Get Started' button directly to 'getting-started/quick-start/' and 'View Architecture' to 'advanced-concepts/architecture/overview/', resolving 404 errors.
This branch was successfully deployed
2 participants
Comprehensive documentation overhaul for FlexiRule based on exact source commit 279f576d376bba45a6367a03955a6a4d83019ee6.
PR created automatically by Jules for task 13144167333233669636 started by @abdoruzaqi