Add the user manual and a web pack #17

Merged

erdoar merged 1 commit from claude/manual-and-web into main

2026-10-10 16:58:20 +00:00

erdoar commented

2026-10-10 05:00:16 +00:00

(Migrated from github.com)

Stacked on erdoar/plug#16, because the manual describes the master knob (#14), presets (#15) and the Dock and menu bar (#16). Merge those first.

Summary

MANUAL.md: the user manual. It covers requirements, installing, the first run and permission, a tour of every control (top board, drawer, preset strip), inputs (including how Apps groups helpers, and the shared Safari process), output, effects, the master knob with its 0 dB tack and +10 dB boost, MIDI Learn, presets, the Dock menu and menu bar, where files are kept, and troubleshooting.
Web/: the web pack:
- the icon as SVG and as 1024, 512 and 256 PNGs;
- favicon.svg and favicon-32.png, and a 180 px apple-touch-icon.png;
- the logo and the 1200×630 social banner, as SVG and PNG;
- the menu bar VU glyph as an SVG that takes the text colour;
- plug.css with the brand colours as CSS variables, plus the manual's page style (light and dark);
- manual.html, the manual as a web page built with pandoc, with a pine logo masthead.
Web/README.md lists every file, the colours, a head snippet for a website, and how to rebuild the manual page.
The main README links to the manual and the web pack.

Tested

manual.html rendered in headless Chromium and checked by eye: masthead, contents links, code blocks and tables.
I checked the manual's statements against the code: the taper (−18 dB halfway to the tack, 0 dB at about MIDI value 102), the Dock steps, and the file locations.

🤖 Generated with Claude Code

https://claude.ai/code/session_011C96TJ2L7nzVMFTH7raNu5

Generated by Claude Code

Stacked on erdoar/plug#16, because the manual describes the master knob (#14), presets (#15) and the Dock and menu bar (#16). Merge those first. ## Summary - **`MANUAL.md`:** the user manual. It covers requirements, installing, the first run and permission, a tour of every control (top board, drawer, preset strip), inputs (including how Apps groups helpers, and the shared Safari process), output, effects, the master knob with its 0 dB tack and +10 dB boost, MIDI Learn, presets, the Dock menu and menu bar, where files are kept, and troubleshooting. - **`Web/`:** the web pack: - the icon as SVG and as 1024, 512 and 256 PNGs; - `favicon.svg` and `favicon-32.png`, and a 180 px `apple-touch-icon.png`; - the logo and the 1200×630 social banner, as SVG and PNG; - the menu bar VU glyph as an SVG that takes the text colour; - `plug.css` with the brand colours as CSS variables, plus the manual's page style (light and dark); - `manual.html`, the manual as a web page built with pandoc, with a pine logo masthead. - `Web/README.md` lists every file, the colours, a head snippet for a website, and how to rebuild the manual page. - The main README links to the manual and the web pack. ## Tested - `manual.html` rendered in headless Chromium and checked by eye: masthead, contents links, code blocks and tables. - I checked the manual's statements against the code: the taper (−18 dB halfway to the tack, 0 dB at about MIDI value 102), the Dock steps, and the file locations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_011C96TJ2L7nzVMFTH7raNu5 --- _Generated by [Claude Code](https://claude.ai/code/session_011C96TJ2L7nzVMFTH7raNu5)_