Improve the documentation (#49)

Author: AdrienVannson

docs/quick-start.md renamed to docs/getting-started.md

@@ -3,101 +3,44 @@ Getting Started
 
 ## Installation
 
-Installation from PyPI is as simple as running:
+The package `betterproto2` can be simply installed from PyPI using `pip`:
 
 ```sh
-python3 -m pip install -U betterproto
+pip install betterproto2
 ```
 
-If you are using Windows, then the following should be used instead:
+!!! info
+    The package is compatible with all Python versions from 3.8 to 3.13.
 
-```sh
-py -3 -m pip install -U betterproto
-```
 
-To include the protoc plugin, install `betterproto[compiler]` instead of betterproto,
-e.g.
+## Compiling proto files
 
-```sh
-python3 -m pip install -U "betterproto[compiler]"
-```
+Follow the documentation of [betterproto2 compiler](https://betterproto.github.io/python-betterproto2-compiler/getting-started/) to compile your proto files.
 
 !!! warning
     Make sure that the proto files were generated with a version of `betterproto2_compiler` that is compatible with your
     version of `betterproto2`.
 
-    The version `x.y.z` of `betterproto` is compatible with the version `a.b.c` of the compiler if and only if `a=x` and
-    `b=y`.
-
-## Compiling proto files
-
-
-Given you installed the compiler and have a proto file, e.g `example.proto`:
+    The version `0.x.y` of `betterproto` is compatible with the version `0.a.b` of the compiler if and only if `a=b`.
 
-```proto
-syntax = "proto3";
-
-package hello;
 
-// Greeting represents a message you can tell a user.
-message Greeting {
-    string message = 1;
-}
-```
+## Basic usage
 
-To compile the proto you would run the following:
-
-You can run the following to invoke protoc directly:
-
-```sh
-mkdir hello
-protoc -I . --python_betterproto_out=lib example.proto
-```
-
-or run the following to invoke protoc via grpcio-tools:
-
-```sh
-pip install grpcio-tools
-python -m grpc_tools.protoc -I . --python_betterproto_out=lib example.proto
-```
-
-
-This will generate `lib/__init__.py` which looks like:
+If you successfuly compiled the `example.proto` file from the compiler documentation, you should now be able to use it!
 
 ```python
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# sources: example.proto
-# plugin: python-betterproto
-from dataclasses import dataclass
-
-import betterproto
-
-
-@dataclass
-class Greeting(betterproto.Message):
-    """Greeting represents a message you can tell a user."""
-
-    message: str = betterproto.string_field(1)
+>>> from lib.helloworld import HelloWorld
+>>> msg = HelloWorld(message="Hello world!")
+>>> msg
+HelloWorld(message='Hello world!')
+>>> bytes(msg)
+b'\n\x0cHello world!'
+>>> msg.to_dict()
+{'message': 'Hello world!'}
 ```
 
-Then to use it:
-
-```python
->>> from lib import Greeting
-
->>> test = Greeting()
->>> test
-Greeting(message='')
-
->>> test.message = "Hey!"
->>> test
-Greeting(message="Hey!")
-
->>> bytes(test)
-b'\n\x04Hey!'
->>> Greeting().parse(serialized)
-Greeting(message="Hey!")
-```
+!!! Warning
+    The rest of the documentation is not up to date.
 
 
 ## Async gRPC Support

mkdocs.yml

@@ -12,7 +12,7 @@ theme:
 nav:
   - Betterproto2: 
      - index.md
-     - Quick start: quick-start.md
+     - Getting Started: getting-started.md
      - Tutorial:
         - Messages: tutorial/messages.md
      - API: api.md

pyproject.toml

@@ -135,6 +135,10 @@ rm -rf compiled_files
 """
 help = "Pulls the compiled test files from the betterproto2-compiler repository"
 
+[tool.poe.tasks.serve-docs]
+cmd = "mkdocs serve"
+help = "Serve the documentation locally"
+
 # CI tasks
 
 [tool.poe.tasks.full-test]