steveklabnik/rustdoc

Flag: html in header

Open

#144 opened on Aug 10, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestion

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--html-in-header: include more HTML in

Using this flag looks like this:

$ rustdoc src/lib.rs --html-in-header header.html
$ rustdoc README.md --html-in-header header.html

This flag takes a list of files, and inserts them into the <head> section of the rendered documentation.

Should we keep this flag or not?

Contributor guide

Research direction
Read the linked meta issue and existing comments to understand the context. Evaluate the flag's usage and maintenance cost. Provide a reasoned recommendation on whether to keep or remove the flag.
Tech stack
rust
Domain
documentationtooling
Issue type
Research
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
Rustrustdoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50