diff --git a/docs/field-collaboration.md b/docs/field-collaboration.md deleted file mode 100644 index c373d37..0000000 --- a/docs/field-collaboration.md +++ /dev/null @@ -1,14 +0,0 @@ -# Introduction - -We created the super-repo to collect all best-practice around repository -management to improve the quality and reproducability on tasks and features -like: - -* present results -* create documentaion -* link to other ressources -* community communication -* latest changes -* discussions -* blogs -* ... diff --git a/super-docs/docs/img/oef-logo-white.png b/super-docs/docs/img/oef-logo-white.png deleted file mode 100644 index 49e4bd0..0000000 Binary files a/super-docs/docs/img/oef-logo-white.png and /dev/null differ diff --git a/super-docs/docs/img/rli-logo-selfmade.png b/super-docs/docs/img/rli-logo-selfmade.png deleted file mode 100644 index db83023..0000000 Binary files a/super-docs/docs/img/rli-logo-selfmade.png and /dev/null differ diff --git a/super-docs/docs/img/rli-logo.png b/super-docs/docs/img/rli-logo.png deleted file mode 100644 index 06a2f6c..0000000 Binary files a/super-docs/docs/img/rli-logo.png and /dev/null differ diff --git a/super-docs/docs/index.md b/super-docs/docs/index.md deleted file mode 100644 index 845d491..0000000 --- a/super-docs/docs/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -hide: - - footer - ---- - -# Welcome and get started! - -This page is generated using MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Super-Project layout - - .gitignore # Keep track of all files that should be included by - git. - LICENSE # Provide license information. - README.md # Introduce people to the project goal, results and - link helpful information. - mkdocs.yml # The configuration file. - super-docs/ - stylesheets/ # Store style definition for improved webpage design. - extra.css # Main css styles. - - img/ # Store images and include them in the Webpage. - docs/ # Store documentation content. - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. - - site/ # Store files generated by build command. - - -## Installation - -Install environment and software to create, extend, build and deploy the -documentaion using mkdocs. - -* Install `python` on your system. -* `python -m venv env` to setup a local python developement environment. -* `env\Script\activete` on Windows or `source env\Script\activate` on linux - to activate the env. -* `pip install mkdocs` to install mkdocs in env. -* `pip install mkdocs-material` to install the material theme. -* `mkdocs serve` - Start the live-reloading docs server. - - diff --git a/super-docs/docs/stylesheets/extra.css b/super-docs/docs/stylesheets/extra.css deleted file mode 100644 index a9146c8..0000000 --- a/super-docs/docs/stylesheets/extra.css +++ /dev/null @@ -1,7 +0,0 @@ -:root > * { - --md-primary-fg-color: #0f3b64; - --md-primary-fg-color--dark: #5d6cc0; - --md-typeset-a-color: #5ba6ec; - /* --md-text-font-color: #ffffff; */ - /* --md-primary-fg-color--light: #ECB7B7; */ - } \ No newline at end of file diff --git a/super-docs/docs/super-developer.md b/super-docs/docs/super-developer.md deleted file mode 100644 index 23ea8ed..0000000 --- a/super-docs/docs/super-developer.md +++ /dev/null @@ -1,7 +0,0 @@ -# Super-repo developement - -## Publish - -Publish mkdocs project on github pages (requires permissions on repository) - -* `mkdocs gh-deploy` manually deploy the local docs files to github pages \ No newline at end of file diff --git a/super-docs/docs/super-example-page.md b/super-docs/docs/super-example-page.md deleted file mode 100644 index c373d37..0000000 --- a/super-docs/docs/super-example-page.md +++ /dev/null @@ -1,14 +0,0 @@ -# Introduction - -We created the super-repo to collect all best-practice around repository -management to improve the quality and reproducability on tasks and features -like: - -* present results -* create documentaion -* link to other ressources -* community communication -* latest changes -* discussions -* blogs -* ...