Skip to content

Configuration Guide Updates#118

Open
gonzalesedwin1123 wants to merge 8 commits intov2-odoo19-doc-refreshfrom
v2-config-guide-updates
Open

Configuration Guide Updates#118
gonzalesedwin1123 wants to merge 8 commits intov2-odoo19-doc-refreshfrom
v2-config-guide-updates

Conversation

@gonzalesedwin1123
Copy link
Member

@gonzalesedwin1123 gonzalesedwin1123 commented Feb 5, 2026

Note

Low Risk
Documentation-only updates (figure directives, alt text, captions) with no runtime or configuration logic changes; low risk aside from potential doc build/rendering differences.

Overview
Updates multiple configuration guide pages to replace inline Markdown images with Sphinx/MyST figure directives, adding consistent captions and more descriptive :alt: text for improved accessibility and rendering.

Also refines a few existing figure descriptions in entitlement formula docs (updated :alt: text and caption wording) without changing any product behavior.

Written by Cursor Bugbot for commit a2ca4ef. This will update automatically on new commits. Configure here.

  Improve screenshots 10-12 for dynamic_entitlements.md and conditional_logic.md:
  - Screenshot 10: Highlight Multiplier and Maximum column headers + 2nd row
  - Screenshot 11: Highlight entire entitlement items widget
  - Screenshot 12: Open 3rd item (with condition) instead of 1st, highlight condition domain and amount fields
  - Update captions to short, action-oriented style with bold UI elements
  Replace empty Amount formula highlight with Condition Mode toggle highlight
  in screenshot 12. The item form's formula editor was empty and confusing;
  now highlights the Domain/CEL toggle and Condition Domain builder instead.
  Update caption to reference Condition Mode and rule definition.
…tives

  - Convert 4 markdown image references to MyST {figure} directives with
    alt text and captions
  - Screenshots 01-02: Now correctly show Studio Dashboard and Variables
    list (previously showed wrong content due to URL issues)
  - Screenshots 10-11: Now correctly show Caching & History tab with
    Cache Strategy and Period Granularity fields highlighted (previously
    showed basic form without advanced options enabled)
  - Captions follow overview.md style: short, action-oriented, bold UI
    element names
…gure directives

  - Convert 7 markdown image references to MyST {figure} directives with
    alt text and captions following overview.md style
  - All screenshots now correctly show Studio Variable forms instead of
    Registry Individual pages (URL routing fix in spec)
  - Regenerated all 14 variable screenshots with correct Studio context
…on and highlights

  Convert 4 markdown image references to {figure} directives with captions
  for screenshots 05, 07, 08, and 09. Regenerate all 14 variable screenshots
  with correct source type selections (Model Field, Member Aggregate,
  Computed CEL, Constant/Parameter) and red highlight outlines on key fields.
  Screenshots 01-08 previously showed the Change Request form (wrong model).
  Now correctly show the Change Request Type configuration form with red
  highlights on key fields (Name, Code, Sequence, Icon, Target Type, Detail
  Model, Apply Strategy, Field Mappings, Approval Workflow, Documents).
  Converted all 8 image references from markdown ![]() to MyST {figure}
  directives with descriptive captions.
  Screenshot 11 previously showed only 1 truncated mapping row due to Odoo
  inner container scrolling. Now scrolls apply_mapping_ids widget into view
  showing all 10 Direct Copy mappings with red highlight around the table.
  Converted image reference from markdown ![]() to MyST {figure} directive
  with descriptive caption.
  Improved highlights on screenshots 20-23: Enable Conflict Detection now
  highlights both the section heading and checkbox, Conflict Rules shows
  the table with red outline, Conflict Rule shows configured rule columns,
  and Enable Duplicate Detection highlights heading and checkbox without
  leftover dropdown overlay. Converted all 4 image references from markdown
  ![]() to MyST {figure} directives with descriptive captions.
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @gonzalesedwin1123, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the quality and accessibility of the configuration guide documentation by updating the image embedding syntax. It systematically replaces basic Markdown image links with more robust Sphinx figure directives across various guides. This change enables the inclusion of detailed captions and alternative text for each visual aid, providing richer context and improving the overall user experience and accessibility of the documentation.

Highlights

  • Documentation Image Syntax Update: The pull request migrates image embedding syntax in several configuration guides from standard Markdown ![alt text](image_path) to Sphinx figure directives.
  • Enhanced Image Descriptions: The new Sphinx figure directive allows for the inclusion of more detailed captions and alternative text for each image, improving clarity and accessibility.
  • Improved Readability and Accessibility: By providing richer context and better alternative text, the documentation becomes more user-friendly and accessible for all readers.
Changelog
  • docs/config_guide/change_request_types/conflict_detection.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for conflict detection related images.
  • docs/config_guide/change_request_types/creating_types.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for change request type creation related images.
  • docs/config_guide/change_request_types/field_mappings.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for field mapping related images.
  • docs/config_guide/entitlement_formulas/conditional_logic.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for conditional logic images.
  • docs/config_guide/entitlement_formulas/dynamic_entitlements.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for dynamic entitlements images.
  • docs/config_guide/variables/creating_variables.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for variable creation images.
  • docs/config_guide/variables/overview.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for variable overview images.
  • docs/config_guide/variables/variable_types.md
    • Updated image embedding syntax from Markdown to Sphinx figure directives, adding detailed captions and alt text for variable types images.
Activity
  • No specific human activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates documentation across several configuration guides, replacing Markdown image syntax with Sphinx/MyST figure directives. This improves accessibility with more descriptive alt text and adds contextually relevant captions. The changes are well-executed and enhance the documentation's quality. I have one suggestion in docs/config_guide/entitlement_formulas/conditional_logic.md to improve the clarity of a figure caption to better align with its surrounding example.

Comment on lines +79 to +81
:alt: Entitlement item form with Condition Mode toggle and Domain filter highlighted

Entitlement items with age-based **Condition** expressions for different benefit amounts.
Set the **Condition Mode** to Domain or CEL Expression, then define rules to filter beneficiaries.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The updated caption is a generic instruction. The previous caption, 'Entitlement items with age-based Condition expressions for different benefit amounts.', was more effective as it specifically described how the figure relates to the 'Age-segmented benefits' example. Consider reverting to the previous caption or using a similarly descriptive one to maintain clarity.

Suggested change
:alt: Entitlement item form with Condition Mode toggle and Domain filter highlighted
Entitlement items with age-based **Condition** expressions for different benefit amounts.
Set the **Condition Mode** to Domain or CEL Expression, then define rules to filter beneficiaries.
:alt: Entitlement item form with Condition Mode toggle and Domain filter highlighted
Entitlement items with age-based **Condition** expressions for different benefit amounts.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 5, 2026

Base automatically changed from v2-in-progress-1 to v2-odoo19-doc-refresh February 6, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant