JuliaLang/julia

Better documentation of stdlibs

Open

#28712 opened on Aug 16, 2018

View on GitHub
 (20 comments) (4 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
docsgood first issue

Description

A lot of functionality has been moved from Base to stdlibs. However, for people who haven't been part of this process (especially beginners) it is not really transparent which stdlibs exist and what their purpose is.

The documentation doesn't seem to contain a list of all stdlibs with short descriptions. I think such a list would be very useful as a compact overview of all stdlibs.

The only kind of overview is the navigation pane. There, however, names do not match actual stdlib names and short descriptions are missing.

  1. Do people agree that such a list would be good to have?
  2. Where should such a table go?

Contributor guide

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Julia knowledgefamiliarity with Julia's stdlib structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing documentation structure in Julia's repository, especially the `doc/` directory. Look at the current navigation pane and list of stdlibs. Discuss in the issue (comments) to decide on location and format. Propose a table of stdlibs with short descriptions to be added to the documentation.