Move documentation

Author: AdrienVannson

betterproto2_compiler/docs/development.md betterproto2/docs/development.mdbetterproto2_compiler/docs/development.md renamed to betterproto2/docs/development.md

@@ -1,5 +1,7 @@
 # Development
 
+This page targets the betterproto maintainers.
+
 ## Recompiling the lib proto files
 
 After some updates in the compiler, it might be useful to recompile the standard Google proto files used by the

betterproto2/docs/getting-started.md

@@ -1,29 +1,111 @@
 Getting Started
 ===============
 
-## Installation
+## Compilation
+
+
+### Install protoc
 
-The package `betterproto2` can be simply installed from PyPI using `pip`:
+The betterproto2 compiler is a plugin of `protoc`, you first need to [install](https://grpc.io/docs/protoc-installation/) it.
+
+You can also use it from `grpcio-tools`:
 
 ```sh
-pip install betterproto2[all]
+pip install grpcio-tools
+```
+
+### Install `betterproto2_compiler`
+
+It is possible to install `betterproto2_compiler` using pip:
+
+```
+pip install betterproto2_compiler
+```
+
+### Compile a proto file
+
+Create the following `example.proto` file.
+
+```proto
+syntax = "proto3";
+
+package helloworld;
+
+message HelloWorld {
+    string message = 1;
+}
+
+service HelloService {
+    rpc SayHello (HelloWorld) returns (HelloWorld);
+}
+```
+
+You should be able to compile it using:
+
+```
+mkdir lib
+protoc -I . --python_betterproto2_out=lib example.proto
+```
+
+If you installed `protoc` with `grpc-tools`, the command will be:
+
 ```
+mkdir lib
+python -m grpc.tools.protoc -I . --python_betterproto2_out=lib example.proto
+```
+
+#### Service compilation
+
+##### Clients
+
+By default, for each service, betterproto will generate a synchronous client. Both synchronous and asynchronous clients
+are supported.
+
+  - Synchronous clients rely on the `grpcio` package. Make sure to enable the `grpcio` extra package when installing
+    betterproto2 to use them.
+  - Asynchronous clients rely on the `grpclib` package. Make sure to enable the `grpclib` extra package when installing
+    betterproto2 to use them.
 
-!!! info
-    The package is compatible with all Python versions from 3.10 to 3.13.
+To choose which clients to generate, use the `client_generation` option of betterproto. It supports the following
+values:
 
+  - `none`: Clients are not generated.
+  - `sync`: Only synchronous clients are generated.
+  - `async`: Only asynchronous clients are generated.
+  - `sync_async`: Both synchronous and asynchronous clients are generated.
+        Asynchronous clients are generated with the Async suffix.
+  - `async_sync`: Both synchronous and asynchronous clients are generated.
+        Synchronous clients are generated with the Sync suffix.
+  - `sync_async_no_default`: Both synchronous and asynchronous clients are generated.
+        Synchronous clients are generated with the Sync suffix, and asynchronous clients are generated with the Async
+        suffix.
 
-## Compiling proto files
+For example, `protoc -I . --python_betterproto2_out=lib example.proto --python_betterproto2_opt=client_generation=async`
+will only generate asynchronous clients.
 
-Follow the documentation of [betterproto2 compiler](https://betterproto.github.io/python-betterproto2-compiler/getting-started/) to compile your proto files.
+##### Servers
+
+By default, betterproto will not generate server base classes. To enable them, set the `server_generation` option to
+`async` with `--python_betterproto2_opt=server_generation=async`.
+
+These base classes will be asynchronous and rely on `grpclib`. To use them, make sure to install `betterproto2` with the
+`grpclib` extra package.
+
+
+## Installation
+
+The package `betterproto2` can be installed from PyPI using `pip`:
+
+```sh
+pip install betterproto2[all]
+```
 
 !!! 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 `0.x.y` of `betterproto` is compatible with the version `0.a.b` of the compiler if and only if `a=b`.
 
-
 ## Basic usage
 
 If you successfuly compiled the `example.proto` file from the compiler documentation, you should now be able to use it!

betterproto2/mkdocs.yml

@@ -1,31 +1,28 @@
 site_name: Betterproto2
-site_url: https://betterproto.github.io/python-betterproto2/
+site_url: https://betterproto.github.io/
 theme:
   name: material
   palette:
     primary: deep orange
     accent: deep orange
-  
-  features:
-   - navigation.tabs
 
 nav:
-  - Betterproto2: 
-     - index.md
-     - Getting Started: getting-started.md
-     - Tutorial:
-        - Messages: tutorial/messages.md
-        - Clients: tutorial/clients.md
-     - API: api.md
-  - Betterproto2 compiler: https://betterproto.github.io/python-betterproto2-compiler/
+  - index.md
+  - Getting Started: getting-started.md
+  - Tutorial:
+    - Messages: tutorial/messages.md
+    - Clients: tutorial/clients.md
+  - API: api.md
+  - Development: development.md
+    
 
 plugins:
-- search
-- mkdocstrings:
-    handlers:
-      python:
-        options:
-          show_source: false
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: false
 
 markdown_extensions:
   - admonition