README

notes/

Hand-written prose for the generated action pages.

Every page under Actions is rendered from openapi.yaml by python scripts/generate_wiki.py in the server repo, so editing one directly is pointless — the next run overwrites it. Anything a schema cannot express goes here instead:

notes/screenshot.notes.md   ->  appended to the screenshot wiki page

Create notes/<tool>.notes.md and its contents are included near the bottom of that tool's page, below the generated tables and above the footer links. Regenerating leaves it alone.

Use it for the things worth saying that a parameter table cannot: why one approach is cheaper than another, what a failure usually means, the trap that cost somebody an afternoon. Not for restating a parameter's type.

Why .notes.md and not <tool>.md

A GitHub wiki addresses a page by basename, whatever directory it sits in. notes/screenshot.md and screenshot.md therefore both answer to /wiki/screenshot, and GitHub served the fragment — so the page looked like it had lost everything but its prose while the file on disk was perfect.

The .notes.md suffix is what keeps the two apart. Do not drop it; tests/test_wiki.py fails on any page shadowed this way.