From fbb232a90fe0875bd252d13bf0a82911394cd7c2 Mon Sep 17 00:00:00 2001
From: florian <f.spreckelsen@inidscale.com>
Date: Wed, 4 Aug 2021 17:25:22 +0200
Subject: [PATCH] DOC: Add placeholder for examples
---
docs/make.jl | 1 +
docs/src/examples.md | 29 +++++++++++++++++++++++++++++
docs/src/index.md | 5 +++--
3 files changed, 33 insertions(+), 2 deletions(-)
create mode 100644 docs/src/examples.md
diff --git a/docs/make.jl b/docs/make.jl
index 439db09..682ad3c 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -7,6 +7,7 @@ makedocs(
pages = [
"Home" => "index.md",
"Getting started" => "README_SETUP.md",
+ "examples.md",
"Library" => "api.md",
],
)
diff --git a/docs/src/examples.md b/docs/src/examples.md
new file mode 100644
index 0000000..248fb1a
--- /dev/null
+++ b/docs/src/examples.md
@@ -0,0 +1,29 @@
+# Examples
+
+**TODO** Fill the sections below once the parts have been implemented.
+
+## Connect to a CaosDB server
+
+See also the hints on the [Installation](@ref) and set-up of
+CaosDB.jl. CaosDB.jl makes use of the C++ client of CaosDB, so in
+order to connect to a CaosDB server you first have to configure the
+connection via a configuration file as explained in the [documentation
+of CaosDB's C++
+client](https://docs.indiscale.com/caosdb-cpplib). Once the
+configuration is set up, connecting to the server is as easy as
+
+```julia
+using CaosDB
+connection = CaosDB.Connection.connect()
+```
+
+which will establish a connection and print the version of the server
+you are connected to.
+
+## Retrieve a Record
+
+## Execute queries
+
+## Insert, update, and delete entities
+
+## Download a file
diff --git a/docs/src/index.md b/docs/src/index.md
index dd08abc..86894e4 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -3,10 +3,11 @@
Welcome to CaosDB.jl, the Julia Client for
[CaosDB](https://caosdb.org), the opensource research data management
system. In here you find instruction on how to [Set-up
-CaosDB.jl](@ref) and an overview of [CaosDB.jl's API](@ref).
+CaosDB.jl](@ref), some introductory [Examples](@ref), and an overview
+of [CaosDB.jl's API](@ref).
## Contents
```@contents
-Pages = ["README_SETUP.md", "api.md"]
+Pages = ["README_SETUP.md", "examples.md", "api.md"]
```
--
GitLab