diff --git a/docs/about/authors-notes.md b/docs/about/authors-notes.md new file mode 100644 index 0000000000000000000000000000000000000000..73037ba4be0517413a401af383be256942409f21 --- /dev/null +++ b/docs/about/authors-notes.md @@ -0,0 +1,8 @@ +# Author's notes + +***TODO: about me and the project*** + +* <simon.kirsten@stud.h-da.de> +* <https://github.com/skirsten> +* `Simon#2307` on Discord +* `simon.kirsten@stud.h-da.de` on Slack \ No newline at end of file diff --git a/docs/about/miscellany.md b/docs/about/previous-considerations.md similarity index 98% rename from docs/about/miscellany.md rename to docs/about/previous-considerations.md index d74eeb89d63beea275e09e6c69de2395f702b616..18c08abf30f20b989ad119c03cc013bda63893a7 100644 --- a/docs/about/miscellany.md +++ b/docs/about/previous-considerations.md @@ -1,4 +1,4 @@ -# Miscellany +# Previous considerations ***TODO: explain what this is, improve the existing entries and add missing. Also this might be better in a blog-like layout*** diff --git a/docs/about/twitch-resources.md b/docs/about/twitch-resources.md deleted file mode 100644 index a72d44082e62282814bfc2f1ad4040d02b6c4dec..0000000000000000000000000000000000000000 --- a/docs/about/twitch-resources.md +++ /dev/null @@ -1,3 +0,0 @@ -# Twitch Resources - -***TODO*** \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 7723811d1afde189c05374b8ab1c5d079321b13b..1b394381e7bf04e395ba23386f99dca1a8768d8b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ The goal was to - **Differentiate app designs and diversify stereotypes:** The legacy TV Server only has one endpoint to *discover* content. By providing 7 distinct endpoints to the Twitch API students can differentiate themselves in their project, stereotypes and design. Of course that doesn't mean all endpoints must be used. -- **Improve usefulness:** The apps for the legacy TV Server are pretty much useless after the course. We hope that our project might still be relevant after the course. +- **Improve usefulness:** The apps for the legacy TV Server have no use after and outside the course. We hope that our project enables apps to exceed this lifespan. ## Documentation layout @@ -24,9 +24,9 @@ The goal was to [Download and Run](server/index.md), [Options](server/options.md), [Quickstart](server/quickstart.md), [Reference](server/reference.md) and [Java integration](server/streamtv-java.md). - **About** - [Contributing info (code layout, build and deploy instructions etc.)](about/contributing.md), [License](about/license.md), [Twitch resources](about/twitch-resources.md) and [Miscellany](about/miscellany.md). + [Contributing info (code layout, build and deploy instructions etc.)](about/contributing.md), [Author's notes](about/authors-notes.md), [Previous considerations](about/previous-considerations.md) and [License](about/license.md). !!! info - For the hands-on training not every page of this documentation is important. The _About_ chapter is mostly for internal purposes and curious readers. + For the hands-on training not every page in this documentation is important. The _About_ chapter is mostly for internal purposes and curious readers. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index e3d22bed43f4cfc8ffe3c294a1609be05a33338c..5d8b6a4b390306d2bfba06e52082b6548b5894ce 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,6 +73,6 @@ nav: - About: - Contributing: about/contributing.md + - Author's notes: about/authors-notes.md + - Previous considerations: about/previous-considerations.md - License: about/license.md - - Twitch Resources: about/twitch-resources.md - - Miscellany: about/miscellany.md