Add complete developer documentation with MkDocs#42
Open
julianbei wants to merge 1 commit into
Open
Conversation
- Complete protocol and API reference with examples and diagrams - Structured docs in 10-section layout, ready for navigation - Added mkdocs.yml config and GitHub Actions deployment workflow
Author
|
@synesthesiam any update on this? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi Mike & team,
this PR introduces a complete MkDocs-based documentation system for the Wyoming project. It includes full protocol coverage, Python API usage, and deployment examples – with a clean, navigable structure for developers, contributors, and integrators.
It’s designed to help:
Newcomers understand Wyoming faster
Service creators implement the protocol correctly
Voice devs integrate it into their own stacks
Let me know if you’d like adjustments to structure, naming, or placement!
Thanks for your amazing work on Wyoming – and the entire open voice ecosystem 🙏
Summary:
This PR adds a full developer and protocol documentation suite for the Wyoming project. The documentation is structured for use with MkDocs and the Material for MkDocs theme, providing a clean and navigable developer experience.
📚 What's included
Full protocol reference including all event types, timers, and message formats
Detailed API reference for every exported module/class/function
Flow diagrams and Mermaid sequence charts for communication logic
HTTP endpoint usage examples and curl snippets
Examples of Wyoming service implementations
Contributing guide, roadmap, and ecosystem overview
GitHub Actions workflow to auto-deploy docs to GitHub Pages
Ready-to-serve mkdocs.yml with structured navigation
Modular layout under documentation/docs/ with numbered sections
🚀 How to use
Run mkdocs serve to preview the documentation locally
Push to main to deploy via GitHub Actions (included workflow)
View at https://rhasspy.github.io/wyoming/ (after enabling GitHub Pages)
🤝 Why this matters
Clear, accessible documentation is critical to adoption and contribution. This PR aims to make Wyoming more approachable for:
New developers integrating the protocol
Teams evaluating it for voice assistant backends
Contributors wanting to implement their own Wyoming services
The documentation is designed to scale with the project and encourages community contributions through well-defined structure and open tooling.
I generated most of it so it needs some proofreading which you can do here: https://julianbei.github.io/wyoming/
As context I took everything I know about the protocol, interviews from youtube and material from the "interwebs" that I collected.
Let me know if like it and you'd like any adjustments to structure, tone, or format!