Skip to content

docs: Replace the Home with the README #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leandro-lucarella-frequenz merged 1 commit into from
Nov 4, 2022
Merged

docs: Replace the Home with the README #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ This repository contains channel implementations for python.

If you want to know how to build this project and contribute to it, please
check out the [Contributing
Guide](https://github.com/frequenz-floss/frequenz-channels-python/CONTRIBUTING.md).
Guide](CONTRIBUTING.md).
1 change: 1 addition & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CONTRIBUTING.md"
3 changes: 3 additions & 0 deletions docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* [Home](index.md)
* [API Reference](reference/)
* [Development](CONTRIBUTING.md)
6 changes: 1 addition & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
# Home

Welcome to Frequenz's channels implementation for Python.

This website is still under heavy construction. Most information can be found in the [Reference](reference/frequenz/channels) section.
--8<-- "README.md"