Skip to content

Docs: Document how to include Sketches in Reports (FLCRM-20058)#35

Open
nehilor wants to merge 4 commits intov2from
feature/FLCRM-20058-sketches-docs
Open

Docs: Document how to include Sketches in Reports (FLCRM-20058)#35
nehilor wants to merge 4 commits intov2from
feature/FLCRM-20058-sketches-docs

Conversation

@nehilor
Copy link

@nehilor nehilor commented Mar 5, 2026

Summary

This PR updates the Report Builder documentation to include instructions and examples on how to incorporate Sketches into custom reports. It adds the missing SKETCHURL function reference and provides a new dedicated example page for better developer guidance.

Jira Ticket

FLCRM-20058

Changes

1. Documentation of SKETCHURL Function

  • Updated docs/REPORT BUILDER/reports-introduction/functions.md to include the SKETCHURL(id, options) function.
  • Updated the RENDERVALUES global function example to include logic for isSketchElement, showing how to render sketches alongside photos and signatures.

2. New Sketches Example Page

  • Created docs/REPORT BUILDER/reports-examples/sketches.md which provides:
    • A code snippet for the BODY section of a report.
    • Instructions on how to resize sketches via CSS styles.
    • An example of how to access a specific sketch using a field's data name.

3. Navigation & Consistency

  • Added the new Sketches example to docs/REPORT BUILDER/reports-examples/_order.yaml to ensure it appears in the documentation portal's sidebar.
  • Standardized formatting in functions.md:
    • Replaced *** horizontal rules with ---.
    • Enforced the use of double quotes in JS examples.
    • Added missing semicolons for code consistency.

How to Verify

  1. Review the modified functions.md and ensure the SKETCHURL section is accurate.
  2. Verify the new sketches.md example file follows the project's documentation style.
  3. Confirm that the _order.yaml correctly references the new file.

Copilot AI review requested due to automatic review settings March 5, 2026 17:11
@nehilor nehilor requested review from a team as code owners March 5, 2026 17:11
@nehilor nehilor self-assigned this Mar 5, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates Report Builder docs to explain how to include Sketch fields in custom reports, adding the missing SKETCHURL function reference and a dedicated example page.

Changes:

  • Added documentation for SKETCHURL(id, options) in the functions reference.
  • Extended the RENDERVALUES example to render sketches alongside other media types.
  • Added a new “Sketches” examples page and included it in the examples navigation order.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File Description
docs/REPORT BUILDER/reports-introduction/functions.md Adds SKETCHURL docs and updates existing examples/formatting
docs/REPORT BUILDER/reports-examples/sketches.md New example page showing how to render and style sketches
docs/REPORT BUILDER/reports-examples/_order.yaml Adds the new sketches page to the sidebar order

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Author

@nehilor nehilor left a comment

Choose a reason for hiding this comment

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

Applied feedback: downgraded headings in sketches.md to H2 for consistency.

m1g
m1g previously approved these changes Mar 6, 2026
Copy link

@m1g m1g left a comment

Choose a reason for hiding this comment

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

Looks good.. just one note

Copilot AI review requested due to automatic review settings March 6, 2026 20:32
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

3 participants