readthedocs/sphinx_rtd_theme

Customization options for bitbucket, gitlab, and github are undocumented

Open

#465 opened on Sep 16, 2017

View on GitHub
 (7 comments) (10 reactions) (1 assignee)CSS (1,413 forks)batch import
Good First IssueNeeded: documentation

Repository metrics

Stars
 (3,473 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I had to search the source-code to learn of the existence of these options for 'edit page' links. These should be documented properly with descriptions of their usages.

Contributor guide

Research direction
Examine the theme's source code to locate the undocumented customization options for bitbucket, gitlab, and github edit page links, then document them with descriptions of their usage.
Tech stack
pythoncss
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.
Under 1 hour
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
GitSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85