User-First Documentation Overhaul#62
Conversation
- Reorganized directory structure into Getting Started, Using the Builder, Core Actions, and Advanced Reference. - Rewrote content to focus on user workflows and "how-to" guides. - Isolated technical architecture and developer guides into the Advanced Reference section. - Added aliases to maintain link stability from old paths. - Updated homepage with a clear sectional grid. - Cleaned up redundant files and internal links.
|
👋 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: 470589542b
ℹ️ 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".
| ## Documentation Sections | ||
|
|
||
| {{< grid >}} | ||
| {{< card title="Getting Started" href="/flexirule-docs/getting-started/" >}} |
There was a problem hiding this comment.
These new homepage cards are added to content/en/_index.md, but the site uses layouts/index.html as a full custom home layout and that template never renders .Content; the visible hero/tutorial links there still point to /docs/.... Since this commit also removes content/en/docs/_index.md, users clicking the rendered homepage CTAs will still be sent to deleted /docs/ routes instead of these new sections.
Useful? React with 👍 / 👎.
| --- | ||
| title: Core Actions | ||
| description: Comprehensive guide to the available actions in FlexiRule. | ||
| weight: 30 | ||
| --- |
There was a problem hiding this comment.
Moving the action docs into a top-level core-actions section leaves these pages outside the navigation that is actually rendered: layouts/_default/baseof.html only includes the sidebar for .Section == "docs" or .Type == "docs", and layouts/partials/sidebar.html only emits the docs section. As a result /core-actions/... pages render without the documentation sidebar/mobile menu even though they are now primary documentation pages.
Useful? React with 👍 / 👎.
| ## Related Topics | ||
| - [Action Documentation]({{< relref "docs/actions/notify/_index.md" >}}) | ||
| - [Execution Semantics]({{< relref "docs/reference/execution/notify.md" >}}) | ||
| - [Action Documentation]({{< relref "core-actions/notify-action/_index.md" >}}) |
There was a problem hiding this comment.
The consolidated Notify action page is content/en/core-actions/notify-action.md, not an _index.md bundle, so this relref target does not exist; the same bad target also appears in content/en/advanced-reference/reference/execution/notify.md. The Hugo build step in the Pages workflow resolves relrefs, so both links need to point at core-actions/notify-action.md before the site can build reliably.
Useful? React with 👍 / 👎.
| ### Complex Outputs | ||
| - **Group By**: Returns a list of dictionaries with the keys `[group_field, "value"]`. | ||
| - **Query Report**: Returns an object containing `columns` and `result`. See the [Query Report Detail]({{< relref "docs/actions/query-records/query-report" >}}) for usage examples. | ||
| - **Query Report**: Returns an object containing `columns` and `result`. See the [Query Report Detail]({{< relref "core-actions/query-records/query-report" >}}) for usage examples. |
There was a problem hiding this comment.
This link still targets core-actions/query-records/query-report, but the commit deletes the old docs/actions/query-records/query-report/index.md page and only adds the flattened content/en/core-actions/query-records.md. That leaves this relref pointing at no content page, so the Query Records execution page cannot be rendered until it links to an existing page/anchor or the detail page is restored.
Useful? React with 👍 / 👎.
| aliases: | ||
| - /docs/actions/query-records/ |
There was a problem hiding this comment.
Only the old section root is aliased here, but this commit deletes the child URLs such as /docs/actions/query-records/query-report/, /query-list/, /query-doc/, /group-by/, and /aggregations/. External links or search results to those previously published pages now 404 instead of landing on the consolidated Query Records guide, so the deleted child paths should be added as aliases or redirects.
Useful? React with 👍 / 👎.
1 participant
This submission executes a major structural and content overhaul of the FlexiRule documentation.
Key Changes:
docs/structure to a themed hierarchy:getting-started/: Installation and basic concepts.using-the-builder/: Interface navigation and action management.core-actions/: Functional guides for primary rule building blocks.advanced-reference/: Technical, architecture, and developer-specific documentation.advanced-referencesection.aliasesin frontmatter for moved pages to prevent broken external links.relreflinks to the new file paths.content/en/_index.mdwith a grid layout pointing to the four main documentation pillars.content/en/docs/directory.PR created automatically by Jules for task 13570813534659511506 started by @abdoruzaqi