stadiamaps / stadiamaps/ferrostar

More extensive documentation for step advance

Open
#719 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Kotlin
Stars
419
Forks
81
Avg merge
6d 1h
Merged PRs (30d)
7

Description

Step advance has come a long way it the past month or two, to the point that we should probably start documenting best practices in the guide. This will probably be a long running task since we're still discovering what works best for different scenarios, but we can start at a very high level with some things that won't easily be obsoleted.

In parallel and more immediately, we can probably take a refresh pass over the API docs that get published on docs.rs to add more examples. These are great because they are easy to link to and don't suffer from code rot (they run as part of the automated tests :D).

Contributor guide

Open the contributing guide

Research direction

Start by locating the step advance guide and the API documentation published on docs.rs. Document stable, high-level best practices and add examples that are covered by automated tests; the issue does not name specific files or tests, so confirm those entry points first.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.