Nederlands Maintaining the Wiki

Onderhoud van de Wiki

GitHub-wiki's zijn afzonderlijke Git-opslagplaatsen. De GitHub Command Line Interface (gh) kan Git authenticeren, een wiki inschakelen of openen, en repositorycontext bieden, maar bevat momenteel geen eigen commando voor het maken of bewerken van wikipagina's.

Eenmalige installatie

De eerste pagina moet bestaan voordat GitHub de wiki-repository beschikbaar stelt voor klonen. Deze Wiki is al geïnitialiseerd, zodat beheerders de lokale workflow direct kunnen gebruiken.

Authenticeer en configureer de verwerking van Git-referenties:

gh auth login
gh auth setup-git

Kloon de wiki-repository:

git clone https://github.com/Appshines/Voice2Win.wiki.git
Set-Location Voice2Win.wiki

Bewerken en publiceren

Elk Markdown-bestand bestaat uit één pagina. De bestandsnaam wordt het paginaadres; Getting-Started.md wordt bijvoorbeeld gepubliceerd als Getting-Started. _Sidebar.md bestuurt de navigatiezijbalk.

Na bewerking:

git add --all
git commit -m "Update Voice2Win user guide"
git push

Alleen wijzigingen die naar de standaardvertakking van de wiki-repository worden gepusht, worden zichtbaar voor lezers.

Handige GitHub CLI-opdrachten

Open de wiki:

gh browse --wiki --repo Appshines/Voice2Win

Controleer of de functie is ingeschakeld:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

Schakel het indien nodig in:

gh repo edit Appshines/Voice2Win --enable-wiki

Inhoudsconventies

• Groepeer pagina's per taal en gebruik binnen elke taal consistente labels.
• Houd Home kort en stuur gedetailleerde informatie naar gerichte pagina's.
• Update _Sidebar.md telkens wanneer een pagina wordt toegevoegd, verwijderd of hernoemd.
• Geef de voorkeur aan stabiele beschrijvingen boven versiespecifieke schermafbeeldingen of exacte downloadbestandsnamen.
• Documenteer platformverschillen expliciet.
• Leg een afkorting uit wanneer deze voor het eerst op een pagina verschijnt.
• Publiceer nooit koppelingstokens, wachtwoorden, privélogboeken of persoonlijke opnames.
• Test elke interne link na het hernoemen van een pagina.

Officiële gids van GitHub: [Wiki-pagina's toevoegen of bewerken] (https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages).