zsh-users/zsh-syntax-highlighting

docs: Deduplicate ZSH_HIGHLIGHT_STYLES values documentation

Open

#236 aperta il 24 nov 2015

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Shell (1371 fork)batch import
Taskcomponent:docsgood first issueresolution:if-and-when-needed

Metriche repository

Star
 (22.617 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica le sezioni di documentazione duplicate per ZSH HIGHLIGHT STYLES e decidi se ristrutturare i documenti o utilizzare un meccanismo di inclusione. Esamina i commit ded1c8789b07155c833fc49abbb422b93233e81c e 7ee350efcd125c7b6595bf5f59b55c74eae01ad4 per vedere la duplicazione attuale. Pianifica una soluzione che funzioni per tutti i consumatori di documentazione (renderer di GitHub, git worktree, make install).
Tech stack
shell
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75