Setup a basic skeleton for Technical Documentation
Reviewers: buda, dtomicevic Reviewed By: buda Subscribers: pullbot Differential Revision: https://phabricator.memgraph.io/D427
This commit is contained in:
parent
ebdee4e509
commit
46581bfc94
@ -1,11 +1,17 @@
|
||||
# Memgraph End User Techical Documentation
|
||||
# Technical Documentation
|
||||
|
||||
## About Memgraph
|
||||
|
||||
Memgraph is an ACID compliant high performance transactional distributed
|
||||
in-memory graph database featuring runtime native query compiling, lock free
|
||||
data structures, multi-version concurrency control and asynchronous IO.
|
||||
|
||||
Run command:
|
||||
```
|
||||
docker run -p 7687:7687 memgraph
|
||||
```
|
||||
## Contents
|
||||
|
||||
* [About Memgraph](#about-memgraph)
|
||||
* [Installation](installation.md)
|
||||
* [Quick Start](quick-start.md)
|
||||
* [openCypher Query Language](open-cypher.md)
|
||||
* [Interfacing with Memgraph](interfaces.md)
|
||||
* [Upcoming Features](upcoming-features.md)
|
||||
|
||||
|
2
docs/user_technical/couscous.yml
Normal file
2
docs/user_technical/couscous.yml
Normal file
@ -0,0 +1,2 @@
|
||||
title: Memgraph
|
||||
subTitle: Technical Documentation
|
8
docs/user_technical/installation.md
Normal file
8
docs/user_technical/installation.md
Normal file
@ -0,0 +1,8 @@
|
||||
## Installation
|
||||
|
||||
Run command:
|
||||
```
|
||||
docker run -p 7687:7687 memgraph
|
||||
```
|
||||
|
||||
Proceed to [Quick Start](quick-start.md).
|
7
docs/user_technical/interfaces.md
Normal file
7
docs/user_technical/interfaces.md
Normal file
@ -0,0 +1,7 @@
|
||||
## Interfacing with Memgraph
|
||||
|
||||
Describe all supported interfaces:
|
||||
|
||||
* bolt and
|
||||
* web browser.
|
||||
|
3
docs/user_technical/open-cypher.md
Normal file
3
docs/user_technical/open-cypher.md
Normal file
@ -0,0 +1,3 @@
|
||||
## openCypher Query Language
|
||||
|
||||
Details about openCypher
|
4
docs/user_technical/quick-start.md
Normal file
4
docs/user_technical/quick-start.md
Normal file
@ -0,0 +1,4 @@
|
||||
## Quick Start
|
||||
|
||||
Simplest workflow after installation, querying the database...
|
||||
|
3
docs/user_technical/upcoming-features.md
Normal file
3
docs/user_technical/upcoming-features.md
Normal file
@ -0,0 +1,3 @@
|
||||
## Upcoming Features
|
||||
|
||||
List of upcoming features...
|
Loading…
Reference in New Issue
Block a user