akka/akka-core

Consistent doc header casing

Open

#27,741 opened on Sep 18, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

Noted in https://github.com/akka/akka/pull/27708#discussion_r325227829 that our uppercasing in headers is all over the place, we should pick one strategy and stick with it.

My suggestion, Title Capitalization For The Page Title (h1) and Normal capitalization for the subheaders. (I have no writing practice knowledge to motivate it with though)

Contributor guide

Research direction
Identify all documentation headers and apply the selected capitalization strategy: Title Case for page titles (h1) and normal sentence case for subheaders.
Tech stack
scala
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.
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.
85