steveklabnik/rustdoc

Guide-style documentation

Open

#24 opened on Jul 14, 2017

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

Repository metrics

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

Description

Rustdoc should not just provide API documentation, but also support long-form, guide documentation.

My current thought is "use https://github.com/azerupi/mdBook as a library" to do this, but I am open to other thoughts as well.

Contributor guide

Research direction
Investigate how to integrate mdBook as a library to produce guide documentation alongside API docs. Start by understanding mdBook's library API and rustdoc's plugin system.
Tech stack
rust
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50