diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index d3f0d43..e7f284e 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -20,7 +20,26 @@ export default defineUserConfig({ logo: '/images/logos/spacialist_logo_lines_tiny_pad.svg', logoDark: './images/logos/spacialist_logo_lines_tiny_pad_white.svg', - navbar: ['/', '/coding-style'], + navbar: ['/', '/user/guide', '/development/coding-style'], + sidebar: [ + { + text: 'User Guide', + link: '/user/', + children: [ + '/user/guide', + '/user/data' + ] + }, + { + text: 'Development', + link: '/development/', + children: [ + '/development/coding-structure', + '/development/plugins', + '/development/docs', + ] + } + ] }), bundler: viteBundler(), diff --git a/docs/README.md b/docs/README.md index bbdef5c..5f646c0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,17 +5,19 @@ heroImage: ./images/spacialist_logo_lines_black.svg heroImageDark: ./images/spacialist_logo_lines_white.svg actions: - text: User Guide - link: /user-guide/index.html + link: /user/guide.html type: primary - text: Coding Guide - link: /coding-style.html + link: /development/coding-style.html type: primary features: - title: User Guide details: Enduser of the Spacialist Software can find useful resources to unlock the full potential of this versatile work environment. + - title: Plugins + details: Spacialist is build to be easily extensible and adjustable to the project needs. Existing Plugins can be added easily to give a tailored set of features and also provide developers an easy way to extend the software without having to change core functionality. - title: Coding Guide details: Developers can look up the coding philosophy we are using in the project when contributing to the project. diff --git a/docs/coding-structure.md b/docs/coding-structure.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/development/coding-structure.md b/docs/development/coding-structure.md new file mode 100644 index 0000000..7a95ca5 --- /dev/null +++ b/docs/development/coding-structure.md @@ -0,0 +1,2 @@ +# Coding Structure + diff --git a/docs/coding-style.md b/docs/development/coding-style.md similarity index 99% rename from docs/coding-style.md rename to docs/development/coding-style.md index 360d50d..a1ee31a 100644 --- a/docs/coding-style.md +++ b/docs/development/coding-style.md @@ -1,6 +1,5 @@ # Coding Style - ## General Coding Style ## HTML diff --git a/docs/development/docs.md b/docs/development/docs.md new file mode 100644 index 0000000..0557693 --- /dev/null +++ b/docs/development/docs.md @@ -0,0 +1,24 @@ +# Documentation + +This documentation is based on [VuePress](https://vuepress.vuejs.org/), a vue-powered static site generator. +Here you get a brief overview on how to contribute to the growth and the maintainance of this documentation. +The underlying repository is located in [GitHub](https://github.com/DH-Center-Tuebingen/spacialist-docs). + + +## Structure + +There are only a few places of relevance for the average contributor: pages, assets and the config. + +- **Pages** can be found directly in the **/docs/*** directories +- The important **Config**-File can be found in **/docs/.vuepress/config.js** +- **Assets** like images and videos reside inside the **/docs/.vuepress/public/assets/** directory + +## Contributing + +All pages are written in plain Markdown. If you want to change a file, just locate it inside the **/docs/** directory and add the file accordingly. There are some additional Markdown functionalities available. For a more detailed description see the [VuePress Documentation](https://vuepress.vuejs.org/guide/markdown.html). + +If you want to add a page, you also need to register that file inside the **sidebar** section of the config file. For it to show up in the navigation. + +## Final Notes + +That's basically it. Thank you for contributing. \ No newline at end of file diff --git a/docs/plugins.md b/docs/development/plugins.md similarity index 100% rename from docs/plugins.md rename to docs/development/plugins.md diff --git a/docs/structure/vue-structure.md b/docs/development/structure/vue-structure.md similarity index 100% rename from docs/structure/vue-structure.md rename to docs/development/structure/vue-structure.md diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md deleted file mode 100644 index b4573da..0000000 --- a/docs/user-guide/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# User Guide - -Here will be more informations for Spacialist users soon. \ No newline at end of file diff --git a/docs/user/data.md b/docs/user/data.md new file mode 100644 index 0000000..5b9cdbc --- /dev/null +++ b/docs/user/data.md @@ -0,0 +1,3 @@ +# Data Importer + +The data importer is used to import already existing data to the spacialist software using csv files. \ No newline at end of file diff --git a/docs/user/guide.md b/docs/user/guide.md new file mode 100644 index 0000000..c4407ae --- /dev/null +++ b/docs/user/guide.md @@ -0,0 +1,8 @@ +# User Guide + +Here will be more informations for Spacialist users soon. + + +# Data Importer + +Here you find informations about the data importer \ No newline at end of file