void-linux / void-linux/void-docs

Unify `xbps/repositories/signing.md` with `void-packages/README.md`?

Ouverte
#642 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
217
Forks
212
Merge moyen
2 j 21 h
PR mergées (30 j)
1

Description

https://github.com/void-linux/void-docs/pull/641 made me wonder if it's better to drop the section Signing Repositories and link to the README instead. Alternatively, drop the section in the README and link to the docs. Goal: not having duplicate documentation, which will probably lead to divergence in the future again.

But both "solutions" would make one document less self-contained... I don't really like either of them. But right now the README seems more of a "start to finish" guide without many links, so it's probably better to link from the docs to the README?

Another wild idea: Include the whole README into the docs, somewhere below 4. XBPS Package Manager. Not sure if that makes sense...

Maybe I'm just overthinking.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Comparez xbps/repositories/signing.md avec void-packages/README.md et examinez void-linux/void-docs#641 pour prendre en compte la modification de documentation associée. Déterminez quelle source unique doit contenir les instructions de signature, puis vérifiez que la documentation résultante ne comporte aucune section dupliquée et reste compréhensible pour les lecteurs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.