aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md15
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