a-b-street/abstreet

Create a user guide

Open

#560 opened on Mar 10, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (256 forks)batch import
good first issue

Repository metrics

Stars
 (6,779 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Using A/B Street is sometimes hard, especially for tools/features not covered in the tutorial. This issue is a duplicate of https://github.com/a-b-street/docs/issues/1, but in this repo just so I can tag it as "good first issue."

If anybody wants to help with this, docs in any format would help -- editing markdown in https://github.com/a-b-street/docs or even just a Google doc with pictures.

Contributor guide

Research direction
Look at the existing documentation in the a b street/docs repository and the tutorial to identify gaps. Then write a user guide covering features not yet documented.
Tech stack
rust
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.
80