Store documentation screenshots under:

assets/screenshots/

Use raw GitHub links in docs and wiki pages:

![description](https://github.com/joshua-walls/forge/blob/main/assets/screenshots/filename.png?raw=true)

Approved Screenshot Set

These are the canonical screenshots currently used across the README, vault docs, and wiki documentation.

Filename	Purpose
`forge-settings-overview.png`	General Forge settings overview showing the plugin configured and active
`vault-lint-overview.png`	Vault Lint results showing grouped findings and severity organization
`patch-engine-overview.png`	Patch Engine workflow showing patch operations and execution overview
`vault-overview-export.png`	Vault export results showing generated export summaries and outputs
`settings-general-tab.png`	Settings UI focused on General configuration paths and operational folders
`install-docs-command.png`	Command palette showing `Forge: Install Documentation`
`installed-docs-tree.png`	File explorer showing installed `Docs/` and `Examples/` structure
`command-palette-forge-commands.png`	Command palette showing the primary Forge commands
`schema-basic-definition.png`	Example Forge schema note with frontmatter, version line, and YAML contract
`schema-validation-errors.png`	Schema validation output showing configuration or parsing errors
`normalize-tags-before-after.png`	Before and after example of tag normalization
`normalize-frontmatter-before-after.png`	Before and after example of frontmatter normalization
`frontmatter-repair-modal.png`	Vault Repair modal showing suggested frontmatter repairs before confirmation
`ontology-index-export.png`	Generated ontology or relationship index export results
`shape-note-example.png`	Example Shape note showing reusable heading structure
`shape-lint-results.png`	Shape validation or repair results showing structural findings
`patch-dry-run-results.png`	Patch dry-run preview showing changed, skipped, and error counts
`examples-folder-overview.png`	Examples folder expanded to show starter workflows and templates

Screenshot Guidelines

Screenshots should:

use a clean readable theme
avoid personal or sensitive vault data
use realistic example notes
keep the Obsidian UI uncluttered
show the actual workflow state being described
avoid tiny unreadable text regions

Prefer focused screenshots over giant full-screen captures.

Naming Rules

Use:

lowercase filenames
hyphen-separated names
.png format

Good:

vault-lint-overview.png

Avoid:

Screenshot 2025-01-12.png
forgeLintFinal2.png

Deprecated Screenshot Names

These older filenames should no longer be referenced in docs:

forge-vault-repair-modal.png
forge-export-settings.png
forge-shape-repair-results.png
forge-lint-report-note.png
forge-patch-confirm-modal.png
forge-shapes-settings.png
forge-installed-docs-tree.png
screenshot-main.png
screenshot-export.png
screenshot-patch.png

Replace them with the approved screenshot set above.

Reuse Guidance

The same screenshot can and should be reused across multiple notes when appropriate.

Example:

vault-lint-overview.png can be reused in:
- Quick Start
- Vault Lint
- Troubleshooting
- Settings Reference

This keeps the documentation visually consistent and reduces asset sprawl.

Current Coverage

The current screenshot set covers:

installation
command palette workflows
schema validation
linting
patch operations
repair workflows
exports
ontology indexes
normalization
shapes
settings
installed docs/examples

Additional screenshots should only be added when they improve clarity for a real workflow or UI state.