review readme to make it more readable#124
Open
mborne wants to merge 8 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Cette PR réorganise la documentation pour rendre le README.md plus orienté “utilisateurs finaux” (exemples / démarrage rapide) et déplacer les informations techniques (configuration, proxy, tests, dev) dans des pages dédiées sous docs/, en ligne avec l’objectif de l’issue #16 (cleanup + simplification).
Changes:
- Refonte du README : ajout d’exemples illustrés, “points clés”, démarrage rapide, et simplification des sections avancées.
- Ajout d’une documentation développeur centralisée (
docs/dev.md) et d’une documentation de configuration (docs/config.md+ sous-pages). - Suppression de l’ancien guide de tests d’intégration (
docs/testing/README.md) au profit du nouveau guide développeur.
Reviewed changes
Copilot reviewed 6 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Recentrage sur l’usage (exemples + quickstart) et liens vers la doc technique. |
| docs/testing/README.md | Suppression du guide tests historique (contenu déplacé). |
| docs/dev.md | Nouveau guide développeur (build, debug, tests, commandes utiles). |
| docs/config.md | Nouvelle page de configuration (variables d’environnement + liens vers pages avancées). |
| docs/config/proxy.md | Nouvelle page dédiée à la configuration proxy (Node --use-env-proxy + variables). |
| docs/config/minisearch.md | Nouvelle page dédiée à la config MiniSearch (GPF_WFS_MINISEARCH_OPTIONS). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Version locale | ||
|
|
||
| #### Avec Docker en local | ||
| > Pré-requis : Node.js (`>=24.5.0` à contrôler avec `node --version`) avec `npx`. |
|
|
||
| !!!tip | ||
| - L'option `--use-env-proxy` est facultative. Voir la [configuration du proxy réseau](./config/proxy.md). | ||
| - Voir [configuration du serveur MCP](docs/config.md) pour les paramètres disponibles |
Comment on lines
+6
to
+10
| - npm compatible avec la version de Node utilisée | ||
|
|
||
| !!!tip "L'utilisation de nvm est possible et recommandée" | ||
| Le dépôt fournit `.nvmrc` et `.node-version`. Si vous utilisez `nvm`, vous pouvez donc faire : | ||
|
|
|
|
||
| ## Points clés | ||
|
|
||
| - L'utilisation du MCP sous forme d'un processus local (`npx -y @ignfab/geocontext`) ne requière pas de paramétrage. |
Comment on lines
+19
to
+23
| | `GPF_WFS_MINISEARCH_OPTIONS` | Chaîne JSON optionnelle permettant de `gpf_wfs_search_types` | options par défaut de `@ignfab/gpf-schema-store` | | ||
| | `LOG_FORMAT` | Le format d'écriture des logs : "json" ou "simple". | "simple" | | ||
| | `LOG_LEVEL` | Le niveau d'écriture des logs : ["error", "info", ou "debug"](https://github.com/winstonjs/winston#logging-levels) | "debug" | | ||
|
|
||
| ## Paramétrage avancés |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(closes #16)