Skip to content

Commit 0fe5e80

Browse files
committed
complete user docs
1 parent 4970953 commit 0fe5e80

32 files changed

Lines changed: 379 additions & 508 deletions

docs/.vitepress/cache/deps/_metadata.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
{
2-
"hash": "08ee2894",
2+
"hash": "90d74c28",
33
"configHash": "3c81eeac",
4-
"lockfileHash": "667581f9",
5-
"browserHash": "559a6195",
4+
"lockfileHash": "3063524b",
5+
"browserHash": "64c22f03",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "8a17a759",
10+
"fileHash": "951d349d",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "f7885ad9",
16+
"fileHash": "31903eaa",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "5e29fc71",
22+
"fileHash": "8b092da5",
2323
"needsInterop": false
2424
},
2525
"vitepress > @vueuse/integrations/useFocusTrap": {
2626
"src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
2727
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28-
"fileHash": "f37b9607",
28+
"fileHash": "8dc222f5",
2929
"needsInterop": false
3030
},
3131
"vitepress > mark.js/src/vanilla.js": {
3232
"src": "../../../../node_modules/mark.js/src/vanilla.js",
3333
"file": "vitepress___mark__js_src_vanilla__js.js",
34-
"fileHash": "77710abf",
34+
"fileHash": "aa4aac3d",
3535
"needsInterop": false
3636
},
3737
"vitepress > minisearch": {
3838
"src": "../../../../node_modules/minisearch/dist/es/index.js",
3939
"file": "vitepress___minisearch.js",
40-
"fileHash": "ac560321",
40+
"fileHash": "0ec44982",
4141
"needsInterop": false
4242
},
4343
"@theme/index": {
4444
"src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
4545
"file": "@theme_index.js",
46-
"fileHash": "4f1eae3c",
46+
"fileHash": "f199e580",
4747
"needsInterop": false
4848
}
4949
},

docs/.vitepress/config.mts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,22 @@ export default defineConfig({
5151
items: [
5252
{ text: 'Preparation',
5353
items: [
54+
{ text: 'Overview', link: '/workflow/preparation/overview'},
5455
{ text: 'Adding sources', link: '/workflow/preparation/add_sources'},
5556
{ text: 'Source states', link: '/workflow/preparation/states'},
5657
{ text: 'Managing sources', link: '/workflow/preparation/manage_sources'},
58+
{ text: 'Editing a source', link: '/workflow/preparation/editing'},
5759
]
5860
},
59-
{ text: 'Coding', link: '/workflow/coding' },
60-
{ text: 'Analysis', link: '/workflow/analysis' },
61-
{ text: 'Publishing', link: '/workflow/publications' },
61+
{ text: 'Coding',
62+
items: [
63+
{ text: 'Overview', link: '/workflow/coding/overview'},
64+
{ text: 'Managing Codes', link: '/workflow/coding/codes'},
65+
{ text: 'Selections', link: '/workflow/coding/selections'},
66+
]
67+
},
68+
{ text: 'Analysis', link: '/workflow/analysis/overview'},
69+
{ text: 'Publishing', link: '/workflow/publications'},
6270
]
6371
},
6472
{

docs/about.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ It is developed by the [ZeMKI (Centre for Media, Communication and Information R
66
at the [University of Bremen](https://www.uni-bremen.de/) and publicly available under https://openqda.org.
77
There, it is hosted at the university's infrastructure.
88

9+
[![qdi logo](https://github.com/openqda/.github/blob/main/profile/zemki-und-uni-logo-weiss-1x.png?raw=true)](https://zemki.uni-bremen.de/)
10+
911
## Software Freedom
1012

1113
OpenQDA intends to be as free as possible. This means for you, that

docs/projects/manage.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22
OpenQDA lets you organize your work in projects.
33
This pages intends to present you the main project management features.
44

5+
## Project page and entries
6+
Your projects are listed on the projects page, which you can reach by clicking
7+
on the projects icon on the [navigation bar](../ui.md).
8+
9+
Every [created project](./create.md) is listed on the left panel
10+
and contains the project name, the date of last update and
11+
some icons.
12+
13+
![project entry example](../public/img/create_project/entry.png)
14+
15+
The key icon indicates projects created by yourself, while the users-icon
16+
indicates projects with [teams](./teams.md).
17+
518
## Select a project
619
After you successfully signed in to OpenQDA you may find
720
there is no current project selected:
@@ -11,6 +24,9 @@ there is no current project selected:
1124
In this case you will not be able to navigate to preparation, coding or analysis and
1225
you will have to select an existing project [or create a new one](./create.md).
1326

27+
Click on a project entry to select it as the current project, which in turn
28+
opens the project management views in the right panel.
29+
1430
## Overview
1531
This is the default for a selected project.
1632
Here you can edit your project information or delete the entire project, including all it's data.
33.4 KB
Loading
18.9 KB
Loading
19.2 KB
Loading
38.9 KB
Loading
60.4 KB
Loading
60.2 KB
Loading

0 commit comments

Comments
 (0)