Docs roadmap #141

The docs site went live in #126 and moved to docs/ in #132. It works, but it was built to get something published, not to be finished. This tracks getting it to the point where the documentation is a reason to trust the SDK rather than a thing the SDK has.

Wave 1, small and self-contained

• Publish the community docs on the site #133 Publish the community docs on the site
• Search does not match underscored identifiers #134 Search does not match underscored identifiers
• Add social cards and a favicon #135 Add social cards and a favicon
• Vendor mermaid instead of loading it from a CDN #136 Vendor mermaid instead of loading it from a CDN

Wave 2, the real gaps

• Generate an API reference with mkdocstrings #137 Generate an API reference with mkdocstrings
• Execute doc code snippets in CI, not just their imports #138 Execute doc code snippets in CI, not just their imports
• Diagram taint propagation and the scan pipeline #139 Diagram taint propagation and the scan pipeline

Wave 3, once the SDK settles

• Versioned docs with mike #140 Versioned docs with mike

What is behind this

An audit of the site turned up the following, all verified rather than assumed:

• 39 of the 40 names in unplug.__all__ already have docstrings, so an API reference is mostly configuration rather than a writing project.
• 26 of the 29 Python snippets in docs/ need no ML and no network, so executing them in CI is practical.
• mkdocs.yml has no plugins: block, so search runs on stock settings and identifiers like check_tool_call do not match.
• The site fetches an unpinned mermaid@11 from unpkg at page load.
• Five root-level docs, including CONTRIBUTING and SUPPORT, are not published at all.

Before starting any of these

#132 is still open and holds the docs/ move. Every issue here references docs/ paths, so wait for it to land.

Issues are taken one at a time. Comment on the one you want and a maintainer will assign it. Four are tagged good first issue, and #139 is mentored, which means someone walks you through it and questions on the thread are the point.