Merge branch 'docs-improve' into 'develop'

docs: Small changes

See merge request la-chariotte/la-chariotte!132

docs/changelog.md

@@ -1,11 +1 @@
-# Changelog
+--8<-- "CHANGELOG.md"
-
-Given a version number `MAJOR`.`MINOR`.`PATCH`:
-
-- `MAJOR` is updated when there are **incompatible changes**,
-- `MINOR` is updated when there are **backwards-compatible feature additions**,
-- `PATCH` is updated when there are **backwards-compatible bug fixes**.
-
-### 1.0.0 (date)
-
-- Basic features.

docs/deploy.md

@@ -4,6 +4,7 @@
 
     This page describes how the main instance is deployed, and is mainly meant as a
     way to share the knowledge. You can obviously do things differently.
+    See the [Getting Started](install.md) page for more information on selfhosting.
 
 ## Services
 

docs/install.md

@@ -32,13 +32,13 @@ pip install -e ".[dev]"
 
 And the frontend dependencies:
 
-=== "Yarn"
+=== "npm"
     
     ```bash
     npm install
     ``` 
 
-=== "npm"
+=== "Yarn"
     ```bash
     yarn install
     ```

mkdocs.yml

@@ -45,3 +45,4 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
       combine_header_slug: true
+  - pymdownx.snippets

pyproject.toml

@@ -39,6 +39,9 @@ build-backend = "setuptools.build_meta"
 
 [project.optional-dependencies]
 dev = [
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.6",
+    "sendria>=2.2",
     "pytest>=7,<8",
     "pip-tools>=6,<7",
     "pytest-isort>=3,<4",