Investigate doc generation from SDK sources

[Devon-White]

Summary

Explore the feasibility of a pipeline that transforms output from popular documentation tooling into SignalWire-styled documentation. This is an investigative effort to evaluate whether the approach is viable before committing to it.

Motivation

Keeping documentation closely aligned with the source code is essential to a great developer experience. Automating doc generation and integrating it with our release process could help ensure documentation stays accurate and up to date with every release. The goal of this issue is to assess whether this is the right approach and what it would take to implement.

Goals

• Research available documentation tooling and evaluate options for converting their output into SignalWire's documentation style.
• Investigate approaches for keeping documentation aligned with the underlying source code.
• Assess how such a pipeline could integrate with the existing release pipeline so documentation updates ship alongside code changes.
• Determine whether manually authored edits can be preserved across regeneration cycles.
• Summarize findings and provide a recommendation on whether to proceed.