Merge pull request #2 from derrabauke/doc-first-review

docs: first lection and restructuring

.vitepress/config.mts

@@ -1,5 +1,5 @@
-import { defineConfig } from 'vitepress'
-const date = new Date;
+import { defineConfig } from "vitepress";
+const date = new Date();
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -9,48 +9,50 @@ export default defineConfig({
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Docs', link: '/docs/' },
-      { text: 'Contributors', link: '/contributors' },
+      { text: "Home", link: "/" },
+      { text: "Docs", link: "/docs/" },
+      { text: "Contributors", link: "/contributors" },
     ],
 
     sidebar: [
       {
-        text: 'Tracking',
+        text: "Tracking",
         items: [
-          { text: 'Activities', link: '/docs/tracking/activities' },
-          { text: 'Attendances', link: '/docs/tracking/attendances' },
-          { text: 'Timesheet', link: '/docs/tracking/timesheet' },
-        ]
+          { text: "Activities", link: "/docs/tracking/activities" },
+          { text: "Attendances", link: "/docs/tracking/attendances" },
+          { text: "Timesheet", link: "/docs/tracking/timesheet" },
+        ],
       },
       {
         items: [
-          { text: 'Analysis', link: '/docs/analysis' },
-          { text: 'Statistics', link: '/docs/statistics' },
-          { text: 'Projects', link: '/docs/projects' },
-          { text: 'Profile Page', link: '/docs/profile' },
-          { text: 'Users Page', link: '/docs/users' },
-          // { text: 'Logout', link: '/docs/logout' }, keep this page here :)
-        ]
+          { text: "Analysis", link: "/docs/analysis" },
+          { text: "Statistics", link: "/docs/statistics" },
+          { text: "Projects", link: "/docs/projects" },
+          { text: "Users", link: "/docs/users" },
+          { text: "Profile", link: "/docs/profile" },
+        ],
       },
       {
+        text: "Details",
         items: [
-          { text: 'Filters', link: '/docs/filters' },
-        ]
-      }
+          { text: "Filters", link: "/docs/details/filters" },
+          { text: "Estimated Effort", link: "/docs/details/estimated_effort" },
+        ],
+      },
     ],
     footer: {
-      message: 'Adfinis Timed is released under the <a href="https://github.com/adfinis/timed-frontend/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a>.',
-      copyright: `Made by Adfinis with ❤️
+      message:
+        'Adfinis Timed is released under the <a href="https://github.com/adfinis/timed-frontend/blob/main/LICENSE">GNU AFFERO GENERAL PUBLIC LICENSE</a>.',
+      copyright: `Made with ❤️ by Adfinis 
       <br>
       Copyright © 2019-${date.getFullYear()} <a href="https://github.com/adfinis/timed-frontend">Adfinis Timed</a>
-      `
+      `,
     },
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/adfinis/timed-frontend' }
+      { icon: "github", link: "https://github.com/adfinis/timed-frontend" },
     ],
     search: {
-      provider: 'local'
-    }
+      provider: "local",
+    },
   },
-})
+});

docs/analysis.md

@@ -1,9 +1,5 @@
 # Analysis
 
-The Analysis page is fetching all reports with it's details,
-it's showing the `User`, `Date`, `Duration`, `Customer`, `Project`, `Task`, `Comment`,
-`Verified By`, `Rejected`, `Review`, `Not Billed`, `Billed`
+To obtain an overview, time reports can also be queried in tabular form. The results can be summarised in very detailed reports using [filters](/docs/details/filters). It is also possible to export these queries in various data formats.
 
 ![Analysis](/analysis/analysis.png){data-zoomable}
-
-Note: You can not see any results with out providing the [Filters](/docs/filters)

docs/details/estimated_effort.md

@@ -0,0 +1,5 @@
+## Estimated Effort
+
+When setting up a project the project manager can enable the estimated effort tracking. After that tasks can define an estimated effort, which will get updated by reports.
+
+<!-- Improve this description -->

docs/details/filters.md

@@ -0,0 +1,36 @@
+# Filters
+
+The filter component is available in `Analysis` and `Statistic` page.
+
+## Task
+
+![Task Filter](/filters/filter_task.png)
+
+You can filter the results via `Customer`, `Project`, `Task`.
+
+## Responsibility
+
+![Task Filter](/filters/responsibility.png)
+
+You can filter the results via `User`, the creator of the report
+or the `Reviewer`, the responsible person of the project or task.
+
+## Finance
+
+![Task Filter](/filters/finance.png)
+
+## Time Range
+
+![Task Filter](/filters/time_range.png)
+
+Simply restrict the query to a specific time period.
+
+## State
+
+![Task Filter](/filters/state.png)
+
+Filter the output according to the status of the report.
+
+#### Review:
+
+While reporting you can decide whether you would like to have a review of the report by your supervisor.

docs/index.md

@@ -1,10 +1,9 @@
 # Timed Documentation
 
-Timed is a Adfinis Product for time tracking
+Timed is a time tracking application built by [Adfinis](https://adfinis.com).
 
+The Adfinis internal instance can be accessed via [https://timed.adfinis.com](https://timed.adfinis.com)
 
-Since [Adfinis](https://adfinis.com) is a provider of services, all services provided must be logged precisely so that they can be invoiced to customers.
+If you want to report an issue or request features, please [check the existing issues for similar or identical tickets](https://github.com/adfinis/timed-frontend/issues/) and if necessary create a new one.
 
-Timed app in Adfinis can be accessed via [https://timed.adfinis.com](https://timed.adfinis.com)
-
-If you want to report an issue or request for new feature, check [this](https://github.com/adfinis/timed-frontend/issues/new/choose) link
+<!-- insert a overview of the app here and highlight the different parts you are going to describe in the further chapters. -->

docs/profile.md

@@ -6,30 +6,16 @@
 
 ![Profile General](/user/general_profile.png){data-zoomable}
 
-In the profile page, you can see the information about the hours that you ware working on,
-in the left, you will see your record since last reported task,
-
-In the center is the chart of your work from today to 7 days before
-
-And in the right, your records for today
+When clicking your name in the top right corner it will show your personal dashboard. This includes the current worktime balance, some general information about your employment, your credits and responsibilities.
 
 ## General Tab
 
 ![User General](/user/general_info.png){data-zoomable}
 
-The general tab contain:
-
-* your worktime and percentage, office location, contract type
-* all your absences in this year
-
 ## Credits Tab
 
 ![User Credits](/user/profile_credits.png){data-zoomable}
 
-Those are the `Absence credits`, and `Overtime credits` that you got from the adminstration
-
 ## Responsibilities Tab
 
 ![User Credits](/user/responsibilities.png){data-zoomable}
-
-Those are the `Projects` that you are managing it and the other employees that Supervising them

docs/projects.md

@@ -1,17 +1,15 @@
 # Projects
 
->If you are a project manager
+::: info
+This part of the application is only available to project managers and admins.
+:::
 
 ![Project Overview](/projects/overview.png){data-zoomable}
 
-This page can be blank for you if you are not set as a manager of project.
-
-This page is for project manager to manage the tasks of your project, and 
-
-having ability to create or modify `Estimated time`, `Remaining effort`, `Archived` of the task
-
+Manage the tasks for a specific project and lay the foundations for organised collaboration.
 
 ## Manage the tasks of your project
+
 ![Edit Task](/projects/edit_task.png){data-zoomable}
 
-by clicking the project task, this form is pop up to help you editing the task or creating new tasks
+To file a new task just enter a description. If already foreseable add an [estimated effort](/docs/details/estimated_effort).

docs/statistics.md

@@ -1,12 +1,11 @@
 # Statistics
 
-The statistics page show you the duration of all reports with out any other
-details, and it show the numbers by `Year`, `Month`, `Customer`. `Project`, `Task`, `User`.
-
+The statistics page shows you a visual representation of the reported work and the remaining budget crunched down by some predefined filters: `Year`, `Month`, `Customer`. `Project`, `Task`, `User`.
 
 ![Statistics](/statistics/statistics.png){data-zoomable}
 
-Note: some filters are not provided without providing the [Filters](/docs/filters)
-* `Customer` require `From Date` to be defined
-* `Project` require `Customer` to be defined
-* `Task` require `Customer`, `Project` to be defined
+Note: Some views require you to select a certain [filter](/docs/details/filters)
+
+- `Customer` require `From Date` to be defined
+- `Project` require `Customer` to be defined
+- `Task` require `Customer`, `Project` to be defined

docs/tracking/activities.md

@@ -1,35 +1,31 @@
 # Activities Tracking
 
+This is the place your day to day time tracking takes place. It should be used as a live dashboard, where you can record your ongoing work and get a quick overview about the past days.
+
 ## Activities bar
 
 ![Activities bar](/tracking/activities/1.png){data-zoomable}
 
-With the activities Bar, you can start an activity, and in the end of the tasks and by the end of the day, you can generate a time sheet from the current activities
-
-You don't need to provide any information about the task that you are working on, but later, to generate the timesheet, the customer, project, task are needed
-
-Note: The tasks that you create via activities bar are not going to be included in your working time, you have to generate a timesheet to include it.
+To start a time tracking we go from left to right and start by selecting a customer. Further you need to choose a project and a task you want to start a time tracking for.
+Ideally you add a comment for the ongoing work as well.
+You can start the tracking with the play button and stop the record with the same button. After you starting a task it will pop up in the activities tab underneath.
+You can resume any task from there as well, by just clicking the respective play button at the end of the row.
 
+Note: The tasks that you've just created won't be included in your working time by solely toggling the play/stop button. For finilizing the time tracking you have to click `Generate timesheet` in the top right of the activities tab.
+This will summarize similar task of the day and create entries in your _timesheet_ tab.
 
 ## Overview Benchmark
 
 ![Overview Benchmark](/tracking/activities/2.png){data-zoomable}
 
-
-The `Overview Benchmark` Component is providing the information about the duration of each working time, you can check your progress virtually, and without needing to go deeply to the details
+Right in the middle of your tracking view you can use the oview component to switch between days and gain a quick overview of you spent hours.
 
 ![Overview Benchmark](/tracking/activities/3.png){data-zoomable}
 
-Those helper methods, will help you to navigate throw the dates, vie going to the next and previus days, or just opening the calendar, and selecting the date, and the `Overview Benchmark` component, will display the inforamtion about the selected date
-
-and the first button in the left, is `Generate Magic Link`,
+On the right you will find a navigation toolbar, which helps to jump back to today or navigate via calendar. The button with the wand icon (magic link), let's you generate links to given task.
 
 ## Magic Link
-![Magic Link](/tracking/activities/4.png){data-zoomable}
 
-This is a great featuer for the team lead and the project manager
-With the magic link, you can define the customer, project, and the task, and also the comment that you want the user to enter the task,
-
-it's useful if you create a list of the task for your team, and then define for the user who is going to work with which task, and you can insert the magic link in the task, with just a click, the user can create the report of his work
+![Magic Link](/tracking/activities/4.png){data-zoomable}
 
-for example: the current working of writing the documentation can be reported in: [https://timed.adfinis.com/reports?task=3610103](https://timed.adfinis.com/reports?task=3610103)
+Sharing links to a given task is made easy by this little generator. Simply pre-define where the work should get booked to and share the link with your team.

docs/tracking/attendances.md

@@ -1,3 +1,3 @@
 # Attendances Tracking
 
-This is Attendances Tracking
+Structure you work day with this simple tool and get a ruff estimate of your working hours for a given day.