Skip to content

Commit

Permalink
Reworked structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Severino committed Oct 2, 2024
1 parent 0ea256b commit 1a71f4b
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 7 deletions.
21 changes: 20 additions & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
Expand Down
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Empty file removed docs/coding-structure.md
Empty file.
2 changes: 2 additions & 0 deletions docs/development/coding-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Coding Structure

1 change: 0 additions & 1 deletion docs/coding-style.md → docs/development/coding-style.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Coding Style


## General Coding Style

## HTML
Expand Down
24 changes: 24 additions & 0 deletions docs/development/docs.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
File renamed without changes.
3 changes: 0 additions & 3 deletions docs/user-guide/index.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/user/data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Data Importer

The data importer is used to import already existing data to the spacialist software using csv files.
8 changes: 8 additions & 0 deletions docs/user/guide.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1a71f4b

Please sign in to comment.