# CVSmia — User Manual

This `docs/` folder contains the local help and user manual source in Markdown. Use these files as the source for generated HTML documentation.

Structure:
- `overview.md` — product overview and concepts
- `quickstart.md` — install, run, quick start
- `ui.md` — UI tour and menu descriptions
- `workflows.md` — common workflows (customize, AI-tailor, manipulate, validate, view)
- `troubleshooting.md` — common issues and fixes
- `usage.nb.md` — local help (Norwegian Bokmal)
- `usage.en.md` — local help (English)
- `usage.md` — fallback/local help landing page
- `examples/sample_resume.json` — example JSON to test the viewer
- `images/` — simple SVG diagrams used in docs

## Generate local help with DocFX

From `src/cvsmia/docs` run:

```powershell
dotnet tool restore
docfx build docfx.json -o .
```

This generates:

- `usage.nb.html`
- `usage.en.html`
- `usage.html` (fallback/landing)

These files are copied to app output and used by `F1` in CVSmia.

Preview images are available under `docs/images/`. Use them in the Markdown files like: `![UI diagram](images/overview_ui.svg)`.

Developer notes:
- JSON validation uses the schema configured by `Settings:JsonResumeSchemaPath` (file or folder).
- AI prompt and system-instruction defaults are configured in `src/cvsmia/ai-prompts.json`, with optional per-user override in `%APPDATA%\Solsem Consulting\CVSmia\ai-prompts.override.json`.
- `AI Assistert CV Manipulator` uses `src/cvsmia/ai-assisted-cv-manipulator-instructions.json` for its predefined instruction presets.
- Støttede lisensmoduler eksponeres i `src/CVSmia.Licensing/license-modules.json` i generisk protokollformat med `protocolVersion`, `application` og `modules[].id`. Filen genereres fra `src/CVSmia.Licensing/EnumAppModules.cs` under build via `tools/update-license-modules-manifest.ps1`, og `None` tas ikke med.
- Integration tests are in `src/CVSmia.App.Tests/integration` (including `EndToEndFlowTests`).
