Skip to content

VISUAL_ASSETS.md

Latest commit

 

History

History
61 lines (47 loc) · 2.37 KB

VISUAL_ASSETS.md

File metadata and controls

61 lines (47 loc) · 2.37 KB
Raw

Visual Assets

AgentContextKit uses public visual assets only when they are safe to publish and useful for understanding the tool.

Public Screenshot Policy

Screenshots must be sanitized before commit. A screenshot is not safe just because it was generated by AgentContextKit; local Web UI and report outputs can include repository metadata, local paths, and finding context.

Assets That Can Be Committed

  • Sanitized screenshots that contain no local paths, private data, raw secret-like values, or customer/client data.
  • Generated diagrams that use generic labels and no local machine information.
  • Small optimized PNG, SVG, or WebP files that are directly useful for docs.

Recommended locations:

docs/assets/screenshots/
docs/assets/diagrams/

Assets That Must Not Be Committed

  • Local .ackit Web UI output.
  • Local .ackit report output.
  • Screenshots that show local absolute paths.
  • Private repository paths.
  • User profile paths.
  • Real secrets, tokens, passwords, API keys, or personal email addresses.
  • Raw scanner finding matches.
  • ZIP, RAR, or other archive files.

Screenshot Checklist

Before committing any screenshot, confirm:

  • No absolute path is visible.
  • No private username is visible.
  • No secret, token, password, or personal email is visible.
  • No customer, client, or private project data is visible.
  • No local machine name is visible.
  • No raw finding match is visible.
  • The image is cropped to the useful UI area.
  • The file size is small enough for repository docs.
  • Browser chrome, local file URLs, shell prompts, and unrelated desktop content are absent.
  • Image metadata has been stripped and the exported file was reopened for a final inspection.

Formats

  • Use SVG for diagrams.
  • Use PNG or WebP for screenshots.
  • Keep files small and avoid high-resolution captures when a cropped view is enough.

How To Regenerate Local Previews

Generate local review artifacts first:

ackit report --output .ackit/reports/demo.html
ackit webui --output .ackit/webui/demo.html

Then manually sanitize any screenshot before committing it under docs/assets/screenshots/.

Generated HTML should remain ignored and local-only. Do not attach generated Web UI or report HTML files to public releases.

For the approved source scenario, candidate filenames, dimensions, metadata review, and commit checklist, use docs/SCREENSHOT_CAPTURE_PLAN.md.