diff options
author | Michael Muré <batolettre@gmail.com> | 2022-05-31 20:20:25 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-31 20:20:25 +0200 |
commit | 96327c3371ca762d906209c6114092bbf552c0f4 (patch) | |
tree | cc236674c3ba003654e8708f24242a43c161644d /doc/README.md | |
parent | d94df634667146ff854c6da04c5f22bd513c3612 (diff) | |
parent | 1c219f67698771ae3b0d1d08205263e5ba280a71 (diff) | |
download | git-bug-96327c3371ca762d906209c6114092bbf552c0f4.tar.gz |
Merge pull request #806 from MichaelMure/docs
doc: more discoverable docs
Diffstat (limited to 'doc/README.md')
-rw-r--r-- | doc/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..cf9fd845 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,15 @@ +# Documentation + +## For users + +- [data model](model.md) describe how the data model works and why. +- [query language](queries.md) describe git-bug's query language. +- [How-to: Read and edit offline your Github/Gitlab/Jira issues with git-bug](howto-github.md) + +## For developers + +- :exclamation: [data model](model.md) describe how the data model works and why. +- :exclamation: [internal bird-view](architecture.md) gives an overview of the project architecture. +- :exclamation: [Entity/DAG](../entity/dag/example_test.go) explain how to easily make your own distributed entity in git. +- [query language](queries.md) describe git-bug's query language. +- [JIRA bridge de v notes](jira_bridge.md)
\ No newline at end of file |