frequenz-floss / frequenz-channels-python

Channel implementations for Python
https://frequenz-floss.github.io/frequenz-channels-python/
MIT License
7 stars 8 forks source link

Add a User Guide #245

Closed llucax closed 9 months ago

llucax commented 10 months ago

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.

llucax commented 10 months ago

This is based on:

Only the commits not present in that PR should be reviewed.

llucax commented 10 months ago

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:

llucax commented 10 months ago

Rebased

llucax commented 9 months ago

Updated with all the suggestions, except for the ones I left follow-up comments.

llucax commented 9 months ago

Please mark the conversation that you happy with the resolution as resolved.

llucax commented 9 months ago

Fixup done, enabling auto-merge.