Closed llucax closed 9 months ago
This is based on:
Only the commits not present in that PR should be reviewed.
You can see the results here: https://llucax.github.io/frequenz-channels-python/v1.0-pre/user-guide/quick-start/
A few comments about stuff I found or thought about while doing this guide:
channel
module with a Channel
abstract class/protocol, would also allow us to expose docs about general channel concepts that is available in IDEs too.Rebased
Updated with all the suggestions, except for the ones I left follow-up comments.
Please mark the conversation that you happy with the resolution as resolved.
Fixup done, enabling auto-merge.
This PR introduces a new
User Guide
top level section in the documentation explaining how to use the library in a more practical and cohesive way than just reading through the API documentation.The bulk of the documentation is still hosted in the code itself, as docstrings, so users can still access most of user guide content directly from their IDE.
It also improves the README and the docs home page, adding a quick start section to both.
Fixes #177.