Modifiez la documentation R+D sur GitHub et soumettez une contribution publique pour examen.
Contribuer à la documentation technique
Chaque titre de page et en-tête de section modifiable comporte un crayon discret.
En le sélectionnant, vous ouvrez le fichier Markdown ou MDX correspondant à la
ligne exacte dans l'éditeur web de GitHub sur main.
Effectuer une modification rapide
- Sélectionnez le crayon à côté du titre de la page ou de la section que vous souhaitez améliorer.
- Connectez-vous à GitHub si vous y êtes invité.
- Modifiez la source en surbrillance. Si vous n'avez pas d'accès en écriture, GitHub crée automatiquement un fork pour vous.
- Sélectionnez Proposer des modifications, décrivez l'amélioration et
ouvrez une pull request vers
main. - Laissez la validation du contenu public se terminer et répondez aux commentaires des mainteneurs.
Après approbation, l'automatisation synchronise le contenu identique octet par
octet dans le dépôt privé de l'application et le site rendu est déployé via le
circuit de publication habituel. Les commits marqués [docs-sync] sont ignorés
par le flux de synchronisation en sens inverse, de sorte que le miroir
bidirectionnel ne peut pas entrer dans une boucle.
Les tâches de synchronisation comparent après chaque transfert les hachages de
l'arborescence de contenu Git. Les fichiers publics sur main restent ainsi
identiques octet par octet à la source rendue, et un lien d'édition ne peut pas
dériver silencieusement vers la mauvaise ligne.
Choisissez le bon référentiel
| Site rendu | Source publique | Contenu modifiable |
|---|---|---|
| Guides de l'utilisateur | researchanddesire/simple-docs | content/ |
| Documents du développeur | researchanddesire/dev-docs | content/docs/ |
| R+D Assembly | researchanddesire/assembly-docs | content/docs/ |
L'application, le moteur de rendu Fumadocs, l'implémentation de l'API, les paramètres de déploiement et les identifiants restent dans le dépôt privé de l'application. Les pages individuelles d'opérations API sont générées à partir du document Dashboard OpenAPI et fournissent donc un lien Signaler un problème de documentation API au lieu d'un crayon de ligne source trompeur.
Écrivez une contribution utile
- Mentionnez le produit pris en charge, la révision matérielle, la version du micrologiciel ou le schéma API lorsque cela est important.
- Reliez les affirmations techniques à l'implémentation ou à la spécification utilisée pour les vérifier.
- Conservez les images à côté de la page qui les utilise et vérifiez chaque chemin relatif.
- Réutilisez les encarts MDX, cartes, onglets, accordéons et étapes existants.
- Gardez chaque pull request ciblée et n'incluez jamais d'identifiants, d'informations privées sur le produit ou de sortie de build générée.
Les petites corrections peuvent être effectuées entièrement dans GitHub. Pour des
modifications plus importantes, créez un fork et clonez le dépôt public, modifiez
son arborescence content/ et utilisez l'extension Fumadocs Preview pour VS Code
avant d'ouvrir la pull request.
Licence
La documentation et les médias appartenant à R+D dans ces dépôts publics sont disponibles sous CC BY-SA 4.0, sauf indication contraire dans un fichier ou un répertoire. Les exemples de code, le code source des produits, le matériel et les ressources tierces conservent leurs licences indiquées.
Les procédures de montage physique appartiennent à R+D Assembly. Les instructions destinées aux consommateurs figurent dans les Guides de l'utilisateur. Gardez la documentation destinée aux développeurs centrée sur les API, les micrologiciels, les protocoles, les interfaces matérielles officielles et les intégrations.
GitHub documente le flux complet de modification et de pull request basé sur un fork.