summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Brahmer <info@b-brahmer.de>2021-05-08 14:34:58 +0200
committerBenjamin Brahmer <info@b-brahmer.de>2021-05-08 20:10:39 +0200
commitb5f89baf388c03d3e3b6ec1e2245633784a60775 (patch)
tree53ead99d9d8902239b5ceb1a37a14a30b45c293d
parent1af4a3523ca04604ff7bd2b30abc391398717ad8 (diff)
start new documentation
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
-rw-r--r--documentation/docs/index.md5
-rw-r--r--documentation/mkdocs.yml3
-rw-r--r--old-docs/README.md (renamed from docs/README.md)0
-rw-r--r--old-docs/explore/README.md (renamed from docs/explore/README.md)0
-rw-r--r--old-docs/externalapi/External-Api.md (renamed from docs/externalapi/External-Api.md)0
-rw-r--r--old-docs/externalapi/Legacy.md (renamed from docs/externalapi/Legacy.md)0
-rw-r--r--old-docs/faq/README.md (renamed from docs/faq/README.md)0
-rw-r--r--old-docs/feedcss/README.md (renamed from docs/feedcss/README.md)0
-rw-r--r--old-docs/install.md (renamed from docs/install.md)0
-rw-r--r--old-docs/maintenance.md (renamed from docs/maintenance.md)0
-rw-r--r--old-docs/plugins/README.md (renamed from docs/plugins/README.md)0
-rw-r--r--old-docs/updateInterval/README.md (renamed from docs/updateInterval/README.md)0
12 files changed, 8 insertions, 0 deletions
diff --git a/documentation/docs/index.md b/documentation/docs/index.md
new file mode 100644
index 000000000..78cdc4af2
--- /dev/null
+++ b/documentation/docs/index.md
@@ -0,0 +1,5 @@
+# Introduction
+
+Welcome to the Nextcloud News APP documentation, it contains information for users, administrators and developers. News is an APP for Nextcloud that can be installed from the offical [APP Store](https://apps.nextcloud.com/apps/news).
+
+News offers the user a RSS/Atom feed reader and can be used to subscribe to multiple feeds, which get automatically updated in the background. Additionally news offers a REST-API that allows clients to syncronize with News. \ No newline at end of file
diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml
new file mode 100644
index 000000000..2c0f7dd3f
--- /dev/null
+++ b/documentation/mkdocs.yml
@@ -0,0 +1,3 @@
+site_name: Nextcloud News APP
+repo_url: https://github.com/nextcloud/news
+edit_uri: blob/master/documentation/ \ No newline at end of file
diff --git a/docs/README.md b/old-docs/README.md
index 62c2dac07..62c2dac07 100644
--- a/docs/README.md
+++ b/old-docs/README.md
diff --git a/docs/explore/README.md b/old-docs/explore/README.md
index be77a2a85..be77a2a85 100644
--- a/docs/explore/README.md
+++ b/old-docs/explore/README.md
diff --git a/docs/externalapi/External-Api.md b/old-docs/externalapi/External-Api.md
index 1848fe5b3..1848fe5b3 100644
--- a/docs/externalapi/External-Api.md
+++ b/old-docs/externalapi/External-Api.md
diff --git a/docs/externalapi/Legacy.md b/old-docs/externalapi/Legacy.md
index 8afb6f9c7..8afb6f9c7 100644
--- a/docs/externalapi/Legacy.md
+++ b/old-docs/externalapi/Legacy.md
diff --git a/docs/faq/README.md b/old-docs/faq/README.md
index ca366910e..ca366910e 100644
--- a/docs/faq/README.md
+++ b/old-docs/faq/README.md
diff --git a/docs/feedcss/README.md b/old-docs/feedcss/README.md
index 74f652eaf..74f652eaf 100644
--- a/docs/feedcss/README.md
+++ b/old-docs/feedcss/README.md
diff --git a/docs/install.md b/old-docs/install.md
index 508c3ec77..508c3ec77 100644
--- a/docs/install.md
+++ b/old-docs/install.md
diff --git a/docs/maintenance.md b/old-docs/maintenance.md
index b99fcfc3c..b99fcfc3c 100644
--- a/docs/maintenance.md
+++ b/old-docs/maintenance.md
diff --git a/docs/plugins/README.md b/old-docs/plugins/README.md
index 97cb792ce..97cb792ce 100644
--- a/docs/plugins/README.md
+++ b/old-docs/plugins/README.md
diff --git a/docs/updateInterval/README.md b/old-docs/updateInterval/README.md
index 133442265..133442265 100644
--- a/docs/updateInterval/README.md
+++ b/old-docs/updateInterval/README.md