Skip to content

[Repo Assist] docs: document --saveimages flag and image embedding patterns#1065

Open
github-actions[bot] wants to merge 3 commits intomainfrom
repo-assist/fix-issue-683-saveimages-docs-67a58dbdddf0aa2d
Open

[Repo Assist] docs: document --saveimages flag and image embedding patterns#1065
github-actions[bot] wants to merge 3 commits intomainfrom
repo-assist/fix-issue-683-saveimages-docs-67a58dbdddf0aa2d

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 3, 2026

🤖 This PR was created by Repo Assist, an automated AI assistant.

Closes #683

Summary

This PR addresses the two documentation gaps reported in #683:

  1. --saveimages flag was not explained — the command-line reference only said "Save images referenced in docs" with no mention of the none/some/all values.
  2. No guidance on embedding image outputs — there was no documentation showing how to embed images (e.g. charts, plots) produced by evaluated scripts.

Changes

docs/commandline.md

  • Expanded --saveimages table entry to document all three values (none/some/all) and which output formats each affects.
  • Added a new Embedding Images section with:
    • A table summarising --saveimages behaviour.
    • An example of inline Base64 image embedding using include-it-raw (the pattern shown in the issue by @gbaydin).
    • A pointer to fsi.AddHtmlPrinter for custom type-based rendering.

docs/evaluation.fsx

  • Expanded the "Using AddPrinter and AddHtmlPrinter" section (previously a single unexplained sentence) with:
    • An explanation of the fsi.AddHtmlPrinter API signature.
    • A concrete example showing how to register a printer that converts a chart value to an inline Base64 (img) tag.
    • An alternative example using a plain inlinePng helper with include-it-raw.

RELEASE_NOTES.md

  • Added entry under [Unreleased] → Added.

Test Status

Documentation-only changes; no code modified. The existing test suite is unaffected.

Generated by Repo Assist for issue #683

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@da02dddebe71d9a937665abdcd1f5214dab852a7

- Expand --saveimages description in commandline.md to explain
  the none/some/all values and their effect on output formats
- Add new 'Embedding Images' section to commandline.md covering
  inline Base64 image embedding via include-it-raw and
  fsi.AddHtmlPrinter for chart/plot output
- Expand 'Using AddPrinter and AddHtmlPrinter' section in
  evaluation.fsx with concrete examples for both approaches
- Update RELEASE_NOTES.md

Closes #683

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dsyme dsyme marked this pull request as ready for review March 4, 2026 09:11
@dsyme dsyme requested a review from nojaf March 4, 2026 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

saveImages flag is not documented or tested

1 participant