jesseduffield / jesseduffield/lazygit

The One Documentation Issue To Rule Them All

Open
#963 5 comments 0 reactions 0 assignees View on GitHub
discussion docs
Dominant language
Go
Stars
82.4k
Forks
3k
Avg merge
2d 18h
Merged PRs (30d)
19

Description

Open to better ways of structuring this but I want to have a single issue for covering all the stuff we need to document better. Often an issue is at a point where it can be closed but the issue would be less likely to come up in the future if the docs were clearer.

Some things off the top of my head:
- [ ] how to edit the config
- [ ] how to customise the log graph
- [ ] how to more easily see selected lines

We should have a section (perhaps in the readme) for 'How do I...' and it can have expandable sections like so:
## How Do I...

Edit the config

blah blah blah

Customise the log graph

blah blah blah

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.