Publish docs on readthedocs

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: ./mkdocs/requirements.txt
+
+mkdocs:
+  configuration: ./mkdocs/mkdocs.yml

README.md

@@ -1,35 +1,114 @@
-# Geotrek-rando V3
+<h1 align="center">Geotrek-rando</h1>
 
-![Search](https://geotrek.ecrins-parcnational.fr/images/gtr3-04-search.jpg)
+<p align="center"><img alt="geotrek rando image" src="/docs/img/geotrek-rando.png"></p>
+
+<p align="center">
+<a href="https://geotrek-rando-v3.readthedocs.io/" rel="nofollow"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-green.svg" style="max-width:100%;"></a>
+<a href="https://gtr3demo.ecrins-parcnational.fr/" rel="nofollow"><img alt="Geotrek Rando demo by Ecrins National Park" src="https://img.shields.io/badge/Demo-PN Ecrins-orange.svg" style="max-width:100%;"></a>
+<a href="https://demo-rando.geotrek.fr/" rel="nofollow"><img alt="Geotrek Rando demo" src="https://img.shields.io/badge/Demo-purple.svg" style="max-width:100%;"></a>
+<a href="https://matrix.to/#/%23geotrek:matrix.org" rel="nofollow"><img alt="Chat Matrix" src="https://img.shields.io/badge/Chat-blue.svg" style="max-width:100%;"></a>
+<a href="https://groups.google.com/g/geotrek-fr" rel="nofollow"><img alt="Forum Google Group" src="https://img.shields.io/badge/Forum-brightgreen.svg" style="max-width:100%;"></a>
+</p>
+<p align="center">
+<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/releases/latest" rel="nofollow"><img alt="Release" src="https://img.shields.io/github/release/GeotrekCE/Geotrek-rando-v3.svg" style="max-width:100%;"></a>
+<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/e2e.yml/badge.svg" style="max-width:100%;"></a>
+<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/action-intall-and-test.yml/badge.svg" style="max-width:100%;"></a>
+<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/release.yml/badge.svg" style="max-width:100%;"></a>
+</p>
+
+<p align="center">
+    <a href="#website"><b>Website</b></a>  •  
+    <a href="#features"><b>Features</b></a>  •  
+    <a href="#admin-documentation"><b>Admin documentation</b></a>  •  
+    <a href="#developer-documentation"><b>Developer documentation</b></a>  •  
+</p>
+<p align="center">
+    <a href="#architecture-decision-record"><b>Architecture decision record </b></a>  •  
+    <a href="#support"><b>Support</b></a>  •   
+    <a href="#contribution"><b>Contribution</b></a>  •  
+    <a href="#thanks-to-all-contributors-"><b>Contributors</b></a>  •  
+    <a href="#license"><b>License</b></a>  • 
+</p>
+
+![Search](/docs/img/home_ecrins.png)
+
+## Website
 
 Geotrek-rando is the public web application displaying the interface you can use to value your territory treks and tourism products! 
-Demo available at https://gtr3demo.ecrins-parcnational.fr.
+You can find two demonstration websites at the following links:
+- [https://gtr3demo.ecrins-parcnational.fr](https://gtr3demo.ecrins-parcnational.fr)
+- [https://demo-rando.geotrek.fr/](https://demo-rando.geotrek.fr)
 
 The third version is a full redesign and rewriting of Geotrek-rando with React, and NextJS for Server side rendering (SSR) and SEO.
 
-Geotrek-rando v3 is directly connected to Geotrek-admin v2 API.
+Geotrek-rando is directly connected to Geotrek-admin v2 API.
+
+Read more in the [general presentation (french)](https://geotrek-rando-v3.readthedocs.io/latest/presentation-fr/).
+
+### Examples of Geotrek-rando portals
+
+- Promoting outdoor activities: [Escapade62](https://www.escapade62.fr/)
+- Exploring the Écrins National Park: [Destination Écrins](https://destination.ecrins-parcnational.fr/)
+- Discover Mediterranean treks, throught land and sea: [Destination Port-Cros](https://destination.portcros-parcnational.fr/)
+- Walks and hikes in the PACA region: [Chemins des Parcs](https://www.cheminsdesparcs.fr/)
+
+![Search](/docs/img/portails.jpg)
+
+Discover more users close to your place by going onto the [user map](https://geotrek.fr/utilisateurs.html).
+
+For a full list of known rando-based applications, visit the [Geotrek applications list](https://github.com/GeotrekCE/Geotrek-website/wiki/Liste-des-Geotrek-connus).
 
-Read more in the [general presentation](./docs/presentation-fr.md).
+## Features
 
-## Documentation for administrators
+Discover Geotrek-Rando's top features, designed to elevate outdoor exploration with dynamic maps, detailed treks info, and offline accessibility—all in a customizable, mobile-friendly interface : 
 
-- [Installation for production](./docs/installation.md)
-- [Customization](./docs/customization.md)
+- **Responsive PWA** interface with offline access
+- **Customizable** homepage
+- **Advanced search** with filters and **interactive map**
+- **Detailed information** on each trek, outdoor activities, touristic services and events
+- **Download options** (PDF, GPX, KML)
+- **Static pages** for general info
+- **Interactive mapping** with elevation profiles
+- **API integration** with Geotrek-Admin for real-time data
+- **Design and content customization** (theme, colors, maps)
+- **SEO optimization** with server-side rendering.
 
-## Documentation for developers
+## Admin documentation
 
-- [Installation on a dev machine](./docs/development.md)
-- [Deployment](./docs/deployment.md)
+- [Production setup](https://geotrek-rando-v3.readthedocs.io/latest/installation/)
+- [Customization](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-introduction/)
 
-## Getting started
+## Developer documentation
 
-- Follow the [development](./docs/development.md) docs
-- Head to [localhost:3000](http://localhost:3000)
+- [Development setup](https://geotrek-rando-v3.readthedocs.io/latest/development/installation/)
+- [Deployment](https://geotrek-rando-v3.readthedocs.io/latest/development/deployment/)
 
-## Architecture decision records
+## Architecture decision record 
 
-- [Main framework](./docs/adrs/main_framework.md)
-- [Deployment solution](./docs/adrs/deployment_solution.md)
+- [Main framework](https://geotrek-rando-v3.readthedocs.io/latest/adrs/main_framework/)
+- [Deployment solution](https://geotrek-rando-v3.readthedocs.io/latest/adrs/deployment_solution/)
+
+## Support
+
+- To report bugs or suggest features, please [submit a ticket](https://github.com/GeotrekCE/Geotrek-rando-v3/issues).
+- Join our community to stay updated and share your experience! Connect on [Matrix](https://matrix.to/#/%23geotrek:matrix.org) for real-time discussions, or connect through the [Google Group](https://groups.google.com/g/geotrek-fr) to exchange ideas and insights.
+
+## Contribution
+
+Interested in contributing? See our [Contributing Guide](https://geotrek-rando-v3.readthedocs.io/latest/development/contributing/). You can help in many ways, the ability to code is not necessary.
+
+## Thanks to all contributors ❤
+
+<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=GeotrekCE/Geotrek-rando-v3" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).
+
+## License
+
+This project is under the MIT License. See the [LICENSE](https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/LICENSE) for details.
 
 <a href="https://territoires.makina-corpus.com/"><img src="https://geotrek.fr/assets/img/logo_makina.svg" alt="Logo MCT" width="115"></a>
 [![](https://geotrek.fr/assets/img/logo_autonomens-h120m.png)](https://datatheca.com/)
+

docs/adrs/deployment_solution.md

@@ -6,7 +6,8 @@
 
 ## Context and Problem Statement
 
-We need to have an easy way to deploy this server for it to be runnable on the most various environments.
+This analysis has been done in 2020, when we started redesigning Geotrek-rando globally, to choose the right technology.  
+We needed to have an easy way to deploy this server for it to be runnable on the most various environments.
 
 ## Decision Drivers sorted by priority
 

docs/adrs/main_framework.md

@@ -6,7 +6,8 @@
 
 ## Context and Problem Statement
 
-In order to produce a scalable, performant and efficient front, we need to choose the right framework head start.
+This analysis has been done in 2020, when we started redesigning Geotrek-rando globally, to choose the right technology.  
+In order to produce a scalable, performant and efficient front, we needed to choose the right framework head start.
 
 ## Decision Drivers sorted by priority
 

docs/changelog.md

@@ -1141,4 +1141,4 @@ If you update Geotrek-rando v3, the global Docker process has been updated to av
 1.x and 2.x
 -----------
 
-See the repository dedicated to versions 1 and 2 of Geotrek-rando: https://github.com/GeotrekCE/Geotrek-rando
+See the repository dedicated to versions 1 and 2 of Geotrek-rando: https://github.com/GeotrekCE/Geotrek-rando