zsh-users/zsh-syntax-highlighting

docs: Deduplicate ZSH_HIGHLIGHT_STYLES values documentation

Open

#236 opened on Nov 24, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Shell (22,617 stars) (1,371 forks)batch import
Taskcomponent:docsgood first issueresolution:if-and-when-needed

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.

Contributor guide

Tech stack
shell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
read docs folderunderstand ZSH HIGHLIGHT STYLESknowledge of Markdownbasic shell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at the commit references (ded1c8789b07155c833fc49abbb422b93233e81c and 7ee350efcd125c7b6595bf5f59b55c74eae01ad4) to see the duplicated documentation. The repo uses a docs/ directory. Consider restructuring the highlighters documentation to reduce duplication, possibly by using include mechanisms or interlinking. Ensure the solution works for both GitHub rendering and local installed trees.