📝 Add Docs section to the TODO list

📄 Rewrite reference of the origin of the project name
📄 Replace WIP tag with a reference to the origin of the project name
2024-01-08 23:03:59 +01:00 · 2024-01-07 11:42:44 +01:00 · 2024-01-07 11:39:04 +01:00 · 2024-01-07 11:35:46 +01:00
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+# 🚧 Carrramba! Encore raté! 🚧

 Resident of the Ile-de-France,

@@ -94,6 +95,16 @@ transport operators in Ile-de-France. These specifications are public and availa
 - [ ] Add the capability for the users to pin his/her favorite stops.
 - [ ] Add the address to the stop location.

+## Docs
+
+- [ ] Describe how to build the front-end and back-end docker images.
+- [ ] Describe how to deploy them using `docker compose`.
+- [ ] Add back-end API description ([openAPI](https://www.openapis.org/)) + generate documentation
+      ([mkdoc](https://www.mkdocs.org/), [Redoc](https://github.com/Redocly/redoc)). The best would be to build and
+      deploy it (as docker images) using CI/CD... need to test [Agola](https://agola.io/), [Jaypore
+      CI](https://www.jayporeci.in/) (pipelines configured in Python),
+      [Woodpecker](https://woodpecker-ci.org/docs/intro) or [Drone](https://www.drone.io/) before.
+
 ## Front-end

 - [ ] Add unit tests.
Author	SHA1	Message	Date
Adrien	eead35f822	📝 Add Docs section to the TODO list	2024-01-08 23:03:59 +01:00
Adrien	d7bef20ffc	📄 Rewrite reference of the origin of the project name	2024-01-07 11:42:44 +01:00
Adrien	c2c8c81759	📄 Replace WIP tag with a reference to the origin of the project name	2024-01-07 11:39:04 +01:00
Adrien	98dbf5dfe2	📄 Add WIP tag to the README file	2024-01-07 11:35:46 +01:00