zsh-users/zsh-syntax-highlighting

docs += distro logos?

Open

#902 opened on Nov 11, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Shell (1,371 forks)batch import
IdeaImprovementTaskcomponent:docsgood first issue

Repository metrics

Stars
 (22,617 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Consider adding the logos of each OS, distro, and plugin manager we're packaged in to the documentation (INSTALL.md, perhaps also the landing page README.md).

Compare the use of distro/OS logos in https://subversion.apache.org/packages.

Need to think how to do this without breaking the markdown's usability in source (as opposed to rendered) form.

Split from https://github.com/zsh-users/zsh-syntax-highlighting/pull/877#issuecomment-1173675765

Contributor guide

Research direction
Investigate how to include logos in Markdown documents while maintaining readability in source form; consider using inline HTML or referencing external images; look at examples like Subversion's packages page.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90