From b10cd532cf3d5add5bf620050ee653175a0d2517 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 28 Apr 2023 16:32:13 +0200
Subject: [PATCH] DOC: Better intro to documentation, renamed "Getting
started".
---
README_SETUP.md | 6 +++---
src/doc/conf.py | 6 +++---
src/doc/index.rst | 10 +++++++---
src/doc/{getting_started.md => install.md} | 0
4 files changed, 13 insertions(+), 9 deletions(-)
rename src/doc/{getting_started.md => install.md} (100%)
diff --git a/README_SETUP.md b/README_SETUP.md
index 485835fd..195e2f72 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -20,10 +20,10 @@
*
* ** end header
-->
+# Build and install the Web Interface
-# Getting Started with the Web Interface
Here, we document how to install and build the CaosDB Web Interface. If you are
-only interested in how to use it, please continue [here](tutorials/first_steps.html)
+only interested in how to use it, please continue [here](tutorials/index).
## Folder Structure
@@ -72,7 +72,7 @@ See `build.properties.d/00_default.properties` for more information.
* Run `make clean` to clean up everything.
-## Documentation #
+## Build the documentation #
Build documentation in `build/` with `make doc`.
diff --git a/src/doc/conf.py b/src/doc/conf.py
index cde1d8d6..85a65a38 100644
--- a/src/doc/conf.py
+++ b/src/doc/conf.py
@@ -41,10 +41,10 @@ release = '0.10.2-SNAPSHOT'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
-# 'sphinx_js',
+ # 'sphinx_js',
'sphinx.ext.todo',
"sphinx.ext.autodoc",
-# 'autoapi.extension',
+ # 'autoapi.extension',
"recommonmark", # For markdown files.
"sphinx_rtd_theme",
'sphinx.ext.intersphinx',
@@ -70,7 +70,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
diff --git a/src/doc/index.rst b/src/doc/index.rst
index 24c39434..fe38c99c 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -7,16 +7,20 @@ Welcome to the documentation of CaosDB's web UI!
:caption: Contents:
:hidden:
- Getting started <getting_started>
+ Manual installation <install>
Tutorials <tutorials/index>
Concepts <concepts>
administration/index.rst
Extending the UI <extension>
API <api/index>
+.. note::
-This documentation helps you to :doc:`get started<getting_started>`, explains the most important
-:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
+ Go to `demo.indiscale.com <https://demo.indiscale.com>`__ and take the interactive tour to learn
+ how to use LinkAhead's web interface.
+
+This documentation helps you to :doc:`install the web UI <install>`, explains the most important
+:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials/index>`.
Indices and tables
diff --git a/src/doc/getting_started.md b/src/doc/install.md
similarity index 100%
rename from src/doc/getting_started.md
rename to src/doc/install.md
--
GitLab