docs: add initial documentation structure (#82)

CONTRIBUTING.md

@@ -11,6 +11,7 @@ Thank you for your interest in contributing to the TREND project!
     * [Pull Requests](#pull-requests)
     * [Commits](#commits)
     * [License Header](#license-header)
+* [Documentation](#documentation)
 * [IntelliJ](#intellij)
 * [Style Guide](#style-guide)
     * [IntelliJ IDEA configuration](#intellij-idea-configuration)
@@ -67,6 +68,9 @@ that every proposed contribution is related to a previously discussed issue. Pul
 shouldn't be too big to allow a fast integration of changes. We recommend keeping the content
 below 1000 lines of code (LOC).
 
+To keep to whole project up-to-date, please check and adjust the documentation accordingly. See 
+the [documentation](#documentation) section for more information.
+
 To ensure code quality, every pull request needs at least one approved review from one of the
 Committer team. Further check that all pipelines succeed before a review can be started.
 
@@ -95,6 +99,21 @@ Every source code file in this project must contain a license header. Example:
  */
 ```
 
+## Documentation
+
+Documentation is important for us since it is the starting point for newcomers and a reference for
+experts. We are using the [Docusaurus](https://github.com/facebook/docusaurus/) framework, 
+located in the `docs` folder.
+
+Please always adjust and update the documentation! Extend the existing markdown files in the 
+`docs/docs` folder or create a new file according to the existing structure. Use numbers in 
+front of the file- and folder-names for sorting. Please use kebab case in the file names for a 
+consistent URL-slug.
+
+In case you add a new file (like an image), remember to declare its license according to
+[REUSE](https://reuse.software/) by adding an additional `.license` file (like
+`my-figure.jpg.license` for the `my-figure.jpg` image).
+
 ## IntelliJ
 
 When using IntelliJ, the following describes on how to open and use the project. To work on all

README.md

@@ -6,6 +6,7 @@
 ## Table of Contents
 
 - [About](#about)
+- [Documentation](#documentation)
 - [Structure](#structure)
 - [Getting Started](#getting-started)
     - [System Prerequisites](#system-prerequisites)
@@ -29,6 +30,11 @@ sacrifices.
 > required in addition to the license for the Software. See `LICENSE` for more information. In
 > case of any questions or uncertainties, please contact us at [email protected].
 
+## Documentation
+
+All information from usage until development are collected and provided in our
+[documentation](https://fraunhoferisst.github.io/TREND/).
+
 ## Structure
 
 This project uses a [monolithic repository approach](https://en.wikipedia.org/wiki/Monorepo) and
@@ -62,7 +68,7 @@ The following things are needed to run this application:
 To run the webinterface, just clone the repo locally and run the `docker-compose.yml` file in the
 root directory of the project:
 
-```
+```shell
 $ git clone https://github.com/FraunhoferISST/TREND.git
 $ cd TREND
 $ docker-compose up

docs/docs/01-introduction.mdx

@@ -0,0 +1,31 @@
+---
+title: Introduction
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+
+import PatentHint from './patent-hint.mdx'
+
+<PatentHint components={props.components} />
+
+:::info
+This documentation is in a pretty early stage and updated continuously. Watch it!
+:::
+
+# Introduction
+
+Welcome to the TREND documentation!
+
+If you are interested in ...
+
+- ... just testing TREND: Have a look at the [Getting Started](/docs/getting-started) guide.
+- ... using the TREND watermarker library in your software project or using a command line tool 
+  or webinterface for testing: Have a look at the [Usage](/docs/usage) section.
+- ... developing and contributing on the core or getting familiar with the code base: Have a 
+  look at the [Development](/docs/development) section.

docs/docs/02-getting-started.mdx

@@ -0,0 +1,40 @@
+---
+title: Getting Started
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+
+import PatentHint from './patent-hint.mdx'
+
+<PatentHint components={props.components} />
+
+# Getting Started
+
+Detailed getting started guides are described for every component in their dedicated `README`
+file, located in the corresponding subfolders of the TREND repository. In the following, an easy
+start of the webinterface with the watermarker library is described.
+
+## System Prerequisites
+
+The following things are needed to run this application:
+
+- docker & docker-compose
+
+## Quick Start
+
+To run the webinterface, just clone the repo locally and run the `docker-compose.yml` file in the
+root directory of the project:
+
+```shell
+$ git clone https://github.com/FraunhoferISST/TREND.git
+$ cd TREND
+$ docker-compose up
+```
+
+After the startup finished, try to visit the webinterface at http://localhost:8080

docs/docs/03-usage/10-watermarker/01-installation.md

@@ -0,0 +1,18 @@
+---
+title: Installation
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Installation
+
+_Follows soon._
+
+## System Requirements
+
+## Building from Source

docs/docs/03-usage/10-watermarker/index.mdx

@@ -0,0 +1,18 @@
+---
+title: Watermarker
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+import PatentHint from './../../patent-hint.mdx'
+
+<PatentHint components={props.components} />
+
+# Watermarker
+
+_Follows soon._

docs/docs/03-usage/10-watermarker/java.md

@@ -0,0 +1,17 @@
+---
+title: Java
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Java
+
+If you want to use watermarking inside your Java project, this page gives you the necessary
+information.
+
+_Follows soon._

docs/docs/03-usage/10-watermarker/javascript.md

@@ -0,0 +1,17 @@
+---
+title: JavaScript
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# JavaScript
+
+If you want to use watermarking inside your JavaScript project, this page gives you the necessary
+information.
+
+_Follows soon._

docs/docs/03-usage/11-cli/01-installation.md

@@ -0,0 +1,18 @@
+---
+title: Installation
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Installation
+
+_Follows soon._
+
+## System Requirements
+
+## Building from Source

docs/docs/03-usage/11-cli/commands.md

@@ -0,0 +1,20 @@
+---
+title: Commands
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Commands
+
+The following page gives an overview of possible commands that can be used.
+
+## Embedding Watermarks
+
+## Extracting Watermarks
+
+## General

docs/docs/03-usage/11-cli/index.md

@@ -0,0 +1,14 @@
+---
+title: CLI
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# CLI
+
+_Follows soon._

docs/docs/03-usage/12-webinterface/01-installation.md

@@ -0,0 +1,18 @@
+---
+title: Installation
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Installation
+
+_Follows soon._
+
+## System Requirements
+
+## Building from Source

docs/docs/03-usage/12-webinterface/index.md

@@ -0,0 +1,14 @@
+---
+title: Webinterface
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# Webinterface
+
+_Follows soon._

docs/docs/03-usage/index.mdx

@@ -0,0 +1,39 @@
+---
+title: Usage
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+import PatentHint from './../patent-hint.mdx'
+
+<PatentHint components={props.components} />
+
+# Usage Overview
+
+## Target Group
+If you are a **user** or **developer** and want to / are interested in ...
+
+- ... just testing and playing around with TREND
+- ... using a command line tool to embed or extract watermarks
+- ... using a frontend to embed or extract watermarks in a browser
+- ... using the TREND watermarking library in my project
+
+the following pages provide you with the necessary information.
+
+If you are a **developer** interested in working in the project, planing the change the provided
+webinterface, CLI tool or wartermarker library or interested in developing own extensions,
+please refer to the [Development](/docs/development) section.
+
+## Structure
+They structure is based on the provided components.
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
+```

docs/docs/04-development/10-watermarker/index.mdx

@@ -0,0 +1,19 @@
+---
+title: Watermarker
+description: Core library to embed a byte-encoded sequence inside a cover medium.
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+import PatentHint from './../../patent-hint.mdx'
+
+<PatentHint components={props.components} />
+
+# Watermarker
+
+_Follows soon._

docs/docs/Trendmark.md → docs/docs/04-development/10-watermarker/trendmark.md

@@ -1,3 +1,7 @@
+---
+title: Trendmark
+---
+
 <!--
  Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
 

docs/docs/04-development/11-cli/index.md

@@ -0,0 +1,15 @@
+---
+title: CLI
+description: Command Line Interface build with Kotlin on Java build target.
+---
+
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
+# CLI
+
+_Follows soon._