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 (6,779 stars) (256 forks)batch import
good first issue

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

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.
over 1 week
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
Familiarity with A/B Street software
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by reviewing existing documentation in the repository, particularly the `docs/` folder. The issue is a duplicate of https://github.com/a b street/docs/issues/1, so collaborate there. Consider creating a comprehensive user guide that covers features not in the tutorial.