zsh-users/zsh-syntax-highlighting

docs: Deduplicate ZSH_HIGHLIGHT_STYLES values documentation

Open

#236 ouverte le 24 nov. 2015

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Shell (1 371 forks)batch import
Taskcomponent:docsgood first issueresolution:if-and-when-needed

Métriques du dépôt

Stars
 (22 617 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

As ded1c8789b07155c833fc49abbb422b93233e81c + 7ee350efcd125c7b6595bf5f59b55c74eae01ad4 show, a bit of the highlighters documentation is duplicated a number of times. Deduplicate it, either by restructuring the docs (to add interlinking) or by using some sort of #include-like facility.

Reminder: the consumers for docs are:

  • Users browsing the homepage (which is just the github repository renderer),
  • Users running from a git worktree,
  • Users running from a make installed tree.

Guide contributeur

Direction de recherche
Identifiez les sections de documentation en double pour ZSH HIGHLIGHT STYLES et décidez de restructurer les docs ou d'utiliser un mécanisme d'inclusion. Examinez les commits ded1c8789b07155c833fc49abbb422b93233e81c et 7ee350efcd125c7b6595bf5f59b55c74eae01ad4 pour voir la duplication actuelle. Planifiez une solution qui fonctionne pour tous les consommateurs de documentation (rendu GitHub, git worktree, make install).
Stack technique
shell
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75