more content of the documentation

.vitepress/config.mts

@@ -24,11 +24,18 @@ export default defineConfig({
         ]
       },
       {
-        // text: 'Documentation',
         items: [
-          { text: 'Analysis', link: '/docs/analysis/' },
-          { text: 'Statistics', link: '/docs/statistics/' },
-          { text: 'Projects', link: '/docs/projects/' },
+          { 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 :)
+        ]
+      },
+      {
+        items: [
+          { text: 'Filters', link: '/docs/filters' },
         ]
       }
     ],
@@ -45,5 +52,5 @@ export default defineConfig({
     search: {
       provider: 'local'
     }
-  }
+  },
 })

docs/analysis.md

@@ -0,0 +1,9 @@
+# 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`
+
+![Analysis](/analysis/analysis.png){data-zoomable}
+
+Note: You can not see any results with out providing the [Filters](/docs/filters)

docs/filters.md

@@ -0,0 +1,42 @@
+# Filters
+
+The filter component is used in `Analysis` and `Statistic` page, and you can filter the fetched results via:
+
+## 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)
+
+You can define the time range of the task. so you can fetch the task that is `from` a date or `to` date, or something in between.
+
+
+
+## State
+![Task Filter](/filters/state.png)
+
+The state of the task, whether it's your task or not.
+
+note: In all cases, there is state `All`, even if it's not selected, this is the default value of the all states
+
+#### Review:
+when creating the report, there is a field that can be set `need review`, it will display 
+for the responsible person of the `Project`, `Task`.
+
+by deinig this filter, it will show all reports that have `need review` field, and not reviewed yet

docs/index.md

@@ -3,7 +3,8 @@
 Timed is a Adfinis Product for time tracking
 
 
-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.
+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.
 
 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

docs/logout.md

@@ -0,0 +1,11 @@
+# Logout
+
+> it's not working yet :)
+
+but here some available solutions that you can use it to logout
+
+* clear your browser cookies
+* reinstall your browser
+* restart you computer
+* do factory reset for you computer
+* send us an email and we will delete all your active sessions, and we will reply your email to tell you to refresh the page

docs/profile.md

@@ -0,0 +1,35 @@
+# Profile Page
+
+![User General Overview](/user/user_general.png){data-zoomable}
+
+<hr>
+
+![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
+
+## 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

@@ -0,0 +1,17 @@
+# Projects
+
+>If you are a project manager
+
+![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 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

docs/statistics.md

@@ -0,0 +1,12 @@
+# 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`.
+
+
+![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

docs/tracking/activities.md

@@ -2,7 +2,7 @@
 
 ## Activities bar
 
-![Activities bar](/tracking/activities/1.png)
+![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
 
@@ -13,19 +13,19 @@ Note: The tasks that you create via activities bar are not going to be included
 
 ## Overview Benchmark
 
-![Overview Benchmark](/tracking/activities/2.png)
+![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
 
-![Overview Benchmark](/tracking/activities/3.png)
+![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`,
 
 ## Magic Link
-![Magic Link](/tracking/activities/4.png)
+![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,

docs/users.md

@@ -0,0 +1,11 @@
+# Users Page
+
+![Users](/users.png){data-zoomable}
+
+This page contain the list of users that you Supervising them.
+
+here you can see the time current worktime balance of your employees
+
+![Users Filter](/users_filter.png){data-zoomable}
+
+and you can filter the list of employees via `Supervisor` or `Active` status or search about them

package.json

@@ -1,6 +1,6 @@
 {
   "name": "timed-docs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "authors": {
     "name": "Adfinis",
     "email": "info@adfinis.com"
@@ -12,5 +12,8 @@
   },
   "devDependencies": {
     "vitepress": "^1.0.0-rc.24"
+  },
+  "dependencies": {
+    "medium-zoom": "^1.1.0"
   }
-}
+}