docs: Replace the Home with the README

llucax · llucax · commit 2afc365f5edb · 2022-11-04T12:47:07.000+01:00
Also add a Development section that includes the contents of the
CONTRIBUTING.md file.

This makes it much easier to have one source of truth for the
documentation.

Signed-off-by: Leandro Lucarella &lt;leandro.lucarella@frequenz.com&gt;
diff --git a/README.md b/README.md
@@ -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).
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1 @@
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,3 @@
+* [Home](index.md)
+* [API Reference](reference/)
+* [Development](CONTRIBUTING.md)
diff --git a/docs/index.md b/docs/index.md
@@ -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"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+* [Home](index.md)`
	`2`	`+* [API Reference](reference/)`
	`3`	`+* [Development](CONTRIBUTING.md)`