Documentation
¶
Overview ¶
Package docs renders a protocol.ProviderSchema into human-readable Markdown. The layout is fixed — there are no templates — so any provider, builtin or external, can produce identical-looking docs from its schema alone.
Narrative content (prose intros, notes, worked examples) lives in the schema itself: description fields accept Markdown, and example blocks carry HCL snippets with optional captions. This is the trade-off for template-free generation: provider authors put more into their schema, and tooling picks up the rest automatically.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Render ¶
func Render(schema protocol.ProviderSchema, source string) string
Render returns the Markdown documentation page for schema. The source string is the provider source the user would put in their scenario (e.g. "builtin/postgres" or "exec:./bin/my-provider"); it appears in the "Source" line.
Types ¶
This section is empty.
Source Files