docs: audit · 2026-10-16

[jwilder]

Summary

Fix 4 findings from the Docs audit (docs v1) at d9fd48f, each in a small, easy-to-review step with a test. Docs a newcomer can trust: the API says what it does, the commands in the README work, and what the docs say about flags, config and endpoints is what the code does. Unticked findings stay in the backlog for a later run.

What changes

• Document -wait-retry-interval and -version in the README
• Correct the README template function docs for replace, contains and directory ordering
• Fix the invalid JSON in the README jsonQuery example
• Add a package comment and doc comments for Context, Context.Env, HttpHeader and Config

Testing

Every step adds a test that fails before its fix (or shows the finding no longer reproduces) and runs the project's full existing test suite. A refactor step keeps behaviour, so the existing tests prove it.