LiveSplit / LiveSplit/livesplit-core

Explain the features in the documentation

Open
#387 0 comments 0 reactions 0 assignees View on GitHub
code quality enhancement suitable for contributions
Dominant language
Rust
Stars
227
Forks
81
Avg merge
22h 45m
Merged PRs (30d)
3

Description

livesplit-core has accumulated a bunch of features that you can turn on / off by now. How they interact and what they do is not super obvious, so we should probably add a section to both the README and the Rust documentation that explains it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing README and Rust documentation to inventory the features that can be enabled or disabled. Document what each feature does and how the features interact in both locations. Done means the feature behavior and interactions are explained consistently in the README and Rust documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.