Bewerk R+D-documentatie op GitHub en dien een beoordeelde publieke bijdrage in.
Draag bij aan technische documentatie
Elke bewerkbare paginatitel en sectiekop heeft een subtiel potlood. Als u het
selecteert, wordt het overeenkomstige Markdown- of MDX-bestand op de exacte
regel geopend in de webeditor van GitHub op main.
Voer een snelle bewerking uit
- Selecteer het potlood naast de paginatitel of sectie die u wilt verbeteren.
- Meld u aan bij GitHub als daarom wordt gevraagd.
- Bewerk de gemarkeerde bron. Als u geen schrijftoegang hebt, maakt GitHub automatisch een fork voor u.
- Selecteer Wijzigingen voorstellen, beschrijf de verbetering en open een
pull request naar
main. - Wacht tot de validatie van de openbare inhoud is voltooid en reageer op feedback van de maintainers.
Na goedkeuring synchroniseert automatisering de byte-identieke inhoud naar de
private applicatierepository en wordt de gerenderde site via het normale
releasetraject uitgerold. Commits met [docs-sync] worden genegeerd door de
workflow in de andere richting, zodat de tweerichtingsspiegel niet in een lus
kan raken.
De synchronisatietaken vergelijken na elke overdracht de hashes van de
Git-inhoudsboom. Zo blijven de openbare bestanden op main byte-identiek aan de
gerenderde bron en kan een bewerkingslink niet ongemerkt naar de verkeerde regel
verschuiven.
Kies de juiste opslagplaats
| Gerenderde site | Openbare bron | Bewerkbare inhoud |
|---|---|---|
| Gebruikershandleidingen | researchanddesire/simple-docs | content/ |
| Documenten voor ontwikkelaars | researchanddesire/dev-docs | content/docs/ |
| R+D Assembly | researchanddesire/assembly-docs | content/docs/ |
De applicatie, de Fumadocs-renderer, de API-implementatie, de uitrolinstellingen en de inloggegevens blijven in de private applicatierepository. Afzonderlijke API-operatiepagina's worden gegenereerd uit het Dashboard OpenAPI-document en bieden daarom een link Meld een probleem met API-documentatie in plaats van een misleidend potlood naar de bronregel.
Schrijf een nuttige bijdrage
- Vermeld het ondersteunde product, de hardwarerevisie, de firmwareversie of het API-schema wanneer dat relevant is.
- Koppel technische beweringen aan de implementatie of specificatie waarmee u ze hebt geverifieerd.
- Bewaar afbeeldingen naast de pagina die ze gebruikt en verifieer elk relatief pad.
- Hergebruik de bestaande MDX-callouts, kaarten, tabbladen, accordeons en stappen.
- Houd elke pull request gericht en neem nooit inloggegevens, privéproductinformatie of gegenereerde build-uitvoer op.
Kleine correcties kunnen volledig in GitHub worden uitgevoerd. Voor grotere
wijzigingen kunt u de openbare repository forken en klonen, de content/-structuur
bewerken en de Fumadocs Preview-extensie voor VS Code gebruiken voordat u de pull
request opent.
Licentie
Documentatietekst en media die eigendom zijn van R+D in deze openbare repositories zijn beschikbaar onder CC BY-SA 4.0, tenzij een bestand of map anders aangeeft. Codevoorbeelden, productbroncode, hardwaremateriaal en assets van derden behouden hun vermelde licenties.
Fysieke montageprocedures horen in R+D Assembly. Consumenteninstructies horen in de Gebruikershandleidingen. Houd de Developer Docs gericht op API's, firmware, protocollen, officiële hardware-interfaces en integraties.
GitHub documenteert de volledige flow voor bewerken en op forks gebaseerde pull requests.