Enhance documentation and improve API configuration
- Added VPN connection requirement to README.md for local access to the Logistics API. - Updated documentation_api_logistics.md to clarify usage environments and provide detailed connection instructions. - Modified update-documentation.mdc to include guidelines on handling sensitive information in examples. - Implemented automatic heading ID generation in Documentation.php for better navigation in the documentation. - Updated logistics.php configuration to include default values for base URL, API key, and folder. - Added support contact information in the dashboard view for API-related issues.
This commit is contained in:
@@ -62,8 +62,9 @@ Derniere mise a jour : <date du jour>
|
||||
## Regles
|
||||
|
||||
- Ne jamais supprimer d'information existante sans raison (endpoint supprime du service).
|
||||
- Ne jamais divulguer ou ecrire des informations sensibles (cles d'API, mots de passe, identifiants de connexion, tokens, secrets ou toute autre donnee confidentielle). Utiliser des valeurs fictives ou des placeholders (ex. `votre-cle-api`, `********`, `{API_KEY}`) dans les exemples.
|
||||
- Ton factuel et concis, sans emojis.
|
||||
- Toujours inclure les chemins de fichiers exacts dans les references.
|
||||
- Les exemples de requete doivent utiliser des valeurs realistes.
|
||||
- Les exemples de requete doivent utiliser des valeurs realistes mais ne contenant aucune donnee sensible.
|
||||
- La table des matieres doit refleter les sections du document.
|
||||
- Les endpoints non fonctionnels restent documentes avec le statut "Non fonctionnel" et la description du probleme.
|
||||
Reference in New Issue
Block a user