Code

Add a User Guide#245

Code

Merged

llucax merged 18 commits intofrequenz-floss:v1.x.xfrequenz-floss/frequenz-channels-python:v1.x.xfrom llucax:user-guidellucax/frequenz-channels-python:user-guideCopy head branch name to clipboardDec 13, 2023

+1,766-314

Commits

Commits on Dec 13, 2023

• Add note about other platforms in the README

  Show description for 66cc6dd
  llucax

  committed
  66cc6dd

  Copy full SHA for 66cc6dd

• Add a quick start section to the README

  Show description for 2a8494a
  llucax

  committed
  2a8494a

  Copy full SHA for 2a8494a

• Add a User Guide top level section with a Quick Start

  Show description for 483d23d
  llucax

  committed
  483d23d

  Copy full SHA for 483d23d

• Add the Quick Start also to the docs home page

  Show description for 7405661
  llucax

  committed
  7405661

  Copy full SHA for 7405661

• Move the installation instructions to the user guide

  Show description for 2907ef5
  llucax

  committed
  2907ef5

  Copy full SHA for 2907ef5

• Add the user guide structure

  Show description for a2b4462
  llucax

  committed
  a2b4462

  Copy full SHA for a2b4462

• Improve Anycast class documentation

  Show description for fbe7ab8
  llucax

  committed
  fbe7ab8

  Copy full SHA for fbe7ab8

• Improve Broadcast class documentation

  Show description for 5b340e5
  llucax

  committed
  5b340e5

  Copy full SHA for 5b340e5

• Improve the _exceptions module description

  Show description for 89f84fa
  llucax

  committed
  89f84fa

  Copy full SHA for 89f84fa

• Improve the _merge module description

  Show description for b8e4624
  llucax

  committed
  b8e4624

  Copy full SHA for b8e4624

• Improve the _receiver module description

  Show description for 55f3608
  llucax

  committed
  55f3608

  Copy full SHA for 55f3608

• Improve the _select module description

  Show description for d040ba7
  llucax

  committed
  d040ba7

  Copy full SHA for d040ba7

• Improve the _sender module description

  Show description for 28666a1
  llucax

  committed
  28666a1

  Copy full SHA for 28666a1

• Improve the event module documentation

  Show description for 90d596d
  llucax

  committed
  90d596d

  Copy full SHA for 90d596d

• Improve the file_watcher module documentation

  Show description for 7f51085
  llucax

  committed
  7f51085

  Copy full SHA for 7f51085

• Improve the timer module documentation

  Show description for 5a7e63c
  llucax

  committed
  5a7e63c

  Copy full SHA for 5a7e63c

• README: Make admonitions more readable in GitHub

  Show description for 48906ac
  llucax

  committed
  48906ac

  Copy full SHA for 48906ac

• Update release notes

  Show description for 80a2e78
  llucax

  committed
  80a2e78

  Copy full SHA for 80a2e78