Merge branch 'docs-improve' into 'develop'

docs: Small changes

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

CHANGELOG.md

@@ -1,43 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-since 0.4.1, and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## 1.3.0 (2024-11-02)
-
-This is a small release, with a few features and bugfixes. The code is now
-hosted on https://framagit.org rather than https://gitlab.com.
-
-### Added
-
-- Changed hour and date format in the generated CSV files
-- Added the date in the grouped order dashboard
-- Changed the display of the last possible date and hour to place an order
-- Added the total number of ordered items in the grouped orders overview
-- Removed header line and column for grouped order name in the CSV export for emails
-
-### Fixed
-
-- The "reset password" form is now fixed, it was broken since the last release.
-
-## 1.2.0 (2024-07-12)
-
-A small release, with a few features, a new footer and a `/stats` endpoint.
-
-### Added
-
-- Staff users are now able to see the overview page for a grouped order.
-- Personal information are now autocompleted automatically
-- A `/stats` endpoint has been added, making it possible to see some information
-  about the current instance.
-- The footer has been changed to include more elements, links to the project and
-  documentation.
-
-### Development
-
-- The `main` branch is not used anymore, all the development happens on the
-`develop` branch instead.
-- All the tests have been grouped in the `tests` folder
-- The `requirements.txt` file have been removed in favor of the `pyproject.toml` file.

CHANGELOG.md

@@ -0,0 +1 @@
+docs/changelog.md

docs/changelog.md

@@ -1,11 +1,43 @@
 # Changelog
 
-Given a version number `MAJOR`.`MINOR`.`PATCH`:
+All notable changes to this project will be documented in this file.
 
-- `MAJOR` is updated when there are **incompatible changes**,
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-- `MINOR` is updated when there are **backwards-compatible feature additions**,
+since 0.4.1, and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-- `PATCH` is updated when there are **backwards-compatible bug fixes**.
 
-### 1.0.0 (date)
+## 1.3.0 (2024-11-02)
 
-- Basic features.
+This is a small release, with a few features and bugfixes. The code is now
+hosted on https://framagit.org rather than https://gitlab.com.
+
+### Added
+
+- Changed hour and date format in the generated CSV files
+- Added the date in the grouped order dashboard
+- Changed the display of the last possible date and hour to place an order
+- Added the total number of ordered items in the grouped orders overview
+- Removed header line and column for grouped order name in the CSV export for emails
+
+### Fixed
+
+- The "reset password" form is now fixed, it was broken since the last release.
+
+## 1.2.0 (2024-07-12)
+
+A small release, with a few features, a new footer and a `/stats` endpoint.
+
+### Added
+
+- Staff users are now able to see the overview page for a grouped order.
+- Personal information are now autocompleted automatically
+- A `/stats` endpoint has been added, making it possible to see some information
+  about the current instance.
+- The footer has been changed to include more elements, links to the project and
+  documentation.
+
+### Development
+
+- The `main` branch is not used anymore, all the development happens on the
+`develop` branch instead.
+- All the tests have been grouped in the `tests` folder
+- The `requirements.txt` file have been removed in favor of the `pyproject.toml` file.

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
     ```

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",