init doc work

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
GnomeZworc 2026-06-13 11:21:26 +02:00
commit 4ba5c58a37
Signed by: nicolas.boufideline
GPG key ID: 4406BBBF8845D632
7 changed files with 254 additions and 1 deletions

15
docs/.template.md Normal file
View file

@ -0,0 +1,15 @@
# NAME VERSION
## Upgrade Procedure
```
git fetch --all
git checkout VERSION
docker compose pull
docker compose up -d
```
## Release feature
- ...
- ...

10
docs/README.md Normal file
View file

@ -0,0 +1,10 @@
# Documentation
[Names](https://www.monde-animal.fr/liste-animaux-a-z/)
- [how to dev](./dev.md)
- [how to release](./release.md)
## Release list
- [v0.1.0 Cachalot](./docs/release/v0.1.0_cachalot.md)

1
docs/dev.md Normal file
View file

@ -0,0 +1 @@
# Developpement environement

12
docs/release.md Normal file
View file

@ -0,0 +1,12 @@
# How to release
```
curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s - -t [Version] -n [Name] -c
update all necessary file :
- ./docs/release/next_release.md
- ./docs/README.md
- ./.env
curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s - -u ./docs/README.md
```

5
docs/v0.1.0_cachalot.md Normal file
View file

@ -0,0 +1,5 @@
# Cachalot v0.1.0
## Release feature
- init