README.md

 1# Documentation
 2
 3## Usage
 4
 5The documentation listed below aims to help provide insight into the usage of
 6`git-bug`.
 7
 8- Read about the different [types of workflows](./usage/workflows.md) and check
 9  the [feature matrix](./feature-matrix.md) to learn about `git-bug`
10- Check the [CLI documentation](./md/git-bug.md) for commands and options (or
11  run `man git-bug` after [installation](../INSTALLATION.md))
12- Filter results using the [query language](./usage/query-language.md)
13- Learn how to [sync third party issues](./usage/third-party.md) for offline
14  reading and editing
15
16## For developers
17
18- Read through [`//:CONTRIBUTING.md`][contrib]
19- See an [overview of the internal architecture](./design/architecture.md)
20- Read about the [data model](./design/data-model.md) to gain a deeper
21  understanding of the internals that comprise `git-bug`
22- [`//entity/dag:example_test.go`](../entity/dag/example_test.go) is a good
23  reference to learn how to create a new distributed entity
24- Read the [bridge design documents](./design/bridges) to learn more about each
25  bridge
26
27[contrib]: ../CONTRIBUTING.md