gbdev/pandocs

LOW and HIGH terms might be confusing in SGB docs

Open

#375 opened on Oct 10, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Markdown (134 forks)auto 404
contentgood first issue

Repository metrics

Stars
 (775 stars)
PR merge metrics
 (PR metrics pending)

Description

"LOW" and "HIGH" are used to refer to signals, but a software developer may not have the necessary background to understand what those mean. They should be at least explained in an info box at the top (as per the style guide), and maybe replaced throughout the document where it makes sense to do so.

Contributor guide

Research direction
Review the pandocs style guide for conventions on explaining terms like LOW and HIGH. Identify all instances in the documentation where these terms are used without explanation. Add an info box at the top of each relevant section and replace with clearer terminology where appropriate.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75