# CHM Help

This directory contains the generated ProtoML help source used for both the integrated HTML help viewer and the native Windows CHM build.

It includes:

- `protoml-help.hhp` as the HTML Help Workshop project file
- `TOC.hhc` as the table of contents definition
- `Index.hhk` as the keyword index
- `toc.html` as the visible contents start page
- `help-viewer.html` as the integrated cross-platform help shell with TOC and content pane
- `html_docs/` with the generated help topic pages
- `protoml-help.chm` as a compiled CHM build when generated on Windows

The generated help now combines:

- grouped guide pages for onboarding, workflows, and development
- a wider reference generated from `docs/*.pml`
- TOC and index data that stay aligned with the available help topics

The guided onboarding pages are generated directly into `docs/chm/html_docs/` and linked from `docs/chm/toc.html`.

## Build

To compile the CHM locally on Windows, install Microsoft HTML Help Workshop first.
An archived installer is available here:

```text
https://web.archive.org/web/20160201063255/http://download.microsoft.com/download/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe
```

Regenerate the CHM project files:

```bash
npm run build:chm:project
```

Compile the CHM file on Windows with HTML Help Workshop:

```bash
npm run build:chm
```

## Notes

- The files in this directory are generated by `src/utils/build-chm-docs.js`.
- If you want to change the CHM structure or guide pages, update `src/utils/build-chm-docs.js`.
- If you want to change feature-level reference content, update the source help topics in `docs/*.pml`.