diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..4a95112 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @james-gates-0212 diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ff1a325 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: bundler + directory: / + schedule: + interval: daily + allow: + - dependency-type: direct diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..89b1b04 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,22 @@ +name: CI + +on: + push: + branches: ["main"] + pull_request: + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.3' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + - name: Build with Jekyll + run: bundle exec jekyll build diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..f175116 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,62 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll site to Pages + +on: + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.3' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + - name: Setup Pages + id: pages + uses: actions/configure-pages@v5 + - name: Build with Jekyll + # Outputs to the './_site' directory by default + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c38ceb8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +# Not sure what a .gitignore is? +# See: https://git-scm.com/docs/gitignore + +# These are directly copied from Jekyll's first-party docs on `.gitignore` files: +# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control + +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# Ignore folders generated by Bundler +.bundle/ +vendor/ +node_modules/ diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..93a9d86 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,23 @@ +# Ignore artifacts +.depcheckrc +.DS_Store +.env +.gitignore +.prettierignore +build +dist +frontend +node_modules + +# Ignore files +*.gif +*.ico +*.jpeg +*.jpg +*.lock +*.png +*.svg +*.txt +*.webp +*.woff +*.woff2 diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..3309423 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,6 @@ +{ + "singleQuote": true, + "arrowParens": "always", + "printWidth": 120, + "trailingComma": "all" +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..91b2e88 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,30 @@ +{ + "typescript.updateImportsOnFileMove.enabled": "never", + "typescript.preferences.importModuleSpecifier": "non-relative", + "workbench.colorCustomizations": { + "titleBar.activeForeground": "#000000", + "titleBar.inactiveForeground": "#000000cc", + "titleBar.activeBackground": "#ffc600", + "titleBar.inactiveBackground": "#ffc600cc" + }, + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true, + "[typescriptreact]": { + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true + }, + "[typescript]": { + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true + }, + "[json]": { + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true + }, + "editor.tabSize": 2, + "cSpell.words": [], + "cSpell.language": "en-GB", + "editor.codeActionsOnSave": { + "source.removeUnusedImports": "explicit" + } +} diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..157e918 --- /dev/null +++ b/Gemfile @@ -0,0 +1,7 @@ +source 'https://rubygems.org' + +gem "jekyll", "~> 4.3.4" # installed by `gem jekyll` +# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 + +gem "just-the-docs", "0.10.0" # pinned to the current release +# gem "just-the-docs" # always download the latest release diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..4ced36d --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,98 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + bigdecimal (3.1.8) + colorator (1.1.0) + concurrent-ruby (1.3.4) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + eventmachine (1.2.7) + ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x64-mingw-ucrt) + ffi (1.17.0-x86_64-linux-gnu) + forwardable-extended (2.6.0) + google-protobuf (4.28.1-arm64-darwin) + bigdecimal + rake (>= 13) + google-protobuf (4.28.1-x64-mingw-ucrt) + bigdecimal + rake (>= 13) + google-protobuf (4.28.1-x86_64-linux) + bigdecimal + rake (>= 13) + http_parser.rb (0.8.0) + i18n (1.14.6) + concurrent-ruby (~> 1.0) + jekyll (4.3.4) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + just-the-docs (0.10.0) + jekyll (>= 3.8.5) + jekyll-include-cache + jekyll-seo-tag (>= 2.0) + rake (>= 12.3.1) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (6.0.1) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rexml (3.3.7) + rouge (4.3.0) + safe_yaml (1.0.5) + sass-embedded (1.78.0-arm64-darwin) + google-protobuf (~> 4.27) + sass-embedded (1.78.0-x64-mingw-ucrt) + google-protobuf (~> 4.27) + sass-embedded (1.78.0-x86_64-linux-gnu) + google-protobuf (~> 4.27) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.6.0) + webrick (1.8.1) + +PLATFORMS + arm64-darwin + x64-mingw-ucrt + x86_64-linux-gnu + +DEPENDENCIES + jekyll (~> 4.3.4) + just-the-docs (= 0.10.0) + +BUNDLED WITH + 2.5.9 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7d510d0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 just-the-docs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee61f7b --- /dev/null +++ b/README.md @@ -0,0 +1,174 @@ +# just-the-docs-template + +This is a _bare-minimum_ template to create a [Jekyll] site that: + +- uses the [Just the Docs] theme; +- can be built and published on [GitHub Pages]; +- can be built and previewed locally, and published on other platforms. + +More specifically, the created site: + +- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem; +- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages. + +To get started with creating a site, simply: + +1. click "[use this template]" to create a GitHub repository +2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions + +If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo). + +After completing the creation of your new site on GitHub, update it as needed: + +## Replace the content of the template pages + +Update the following files to your own content: + +- `index.md` (your new home page) +- `README.md` (information for those who access your site repo on GitHub) + +## Changing the version of the theme and/or Jekyll + +Simply edit the relevant line(s) in the `Gemfile`. + +## Adding a plugin + +The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin. + +To add an extra plugin, you need to add it in the `Gemfile` _and_ in `_config.yml`. For example, to add [`jekyll-default-layout`]: + +- Add the following to your site's `Gemfile`: + + ```ruby + gem "jekyll-default-layout" + ``` + +- And add the following to your site's `_config.yml`: + + ```yaml + plugins: + - jekyll-default-layout + ``` + +Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`. + +## Publishing your site on GitHub Pages + +1. If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to: + + ```yaml + title: YOUR TITLE + description: YOUR DESCRIPTION + theme: just-the-docs + + url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME + + aux_links: # remove if you don't want this link to appear on your pages + Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME + ``` + +2. Push your updated `_config.yml` to your site on GitHub. + +3. In your newly created repo on GitHub: + - go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`. + - if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`. + +## Building and previewing your site locally + +Assuming [Jekyll] and [Bundler] are installed on your computer: + +1. Change your working directory to the root directory of your site. + +2. Run `bundle install`. + +3. Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`. + + The built site is stored in the directory `_site`. + +## Publishing your built site on a different platform + +Just upload all the files in the directory `_site`. + +## Customization + +You're free to customize sites that you create with this template, however you like! + +[Browse our documentation][Just the Docs] to learn more about how to use this theme. + +## Hosting your docs from an existing project repo + +You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files. + +### Copy the template files + +1. Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files. + +2. Create a `docs` directory at your project root and copy all remaining template files into this directory. + +### Modify the GitHub Actions workflow + +The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root. + +1. Set the default `working-directory` param for the build job. + + ```yaml + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + ``` + +2. Set the `working-directory` param for the Setup Ruby step. + + ```yaml + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.1' + bundler-cache: true + cache-version: 0 + working-directory: '${{ github.workspace }}/docs' + ``` + +3. Set the path param for the Upload artifact step: + + ```yaml + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: "docs/_site/" + ``` + +4. Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy. + + ```yaml + on: + push: + branches: + - 'main' + paths: + - 'docs/**' + ``` + +## Licensing and Attribution + +This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use! + +The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows]. + +--- + +[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). + +[Jekyll]: https://jekyllrb.com +[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ +[GitHub Pages]: https://docs.github.com/en/pages +[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ +[Bundler]: https://bundler.io +[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate +[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout +[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag +[MIT License]: https://en.wikipedia.org/wiki/MIT_License +[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml +[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..2860757 --- /dev/null +++ b/_config.yml @@ -0,0 +1,30 @@ +title: mscm docs +description: Helps management of day to day administrative activities involved in maintaining case contact and information data, diary, tasks, communications and documents centrally. +theme: just-the-docs + +url: https://mscm-docs.github.io/ + +aux_links: + 'on GitHub': https://github.com/mscm-docs/.github + +permalink: pretty + +defaults: + - scope: + path: '' # an empty string here means all files in the project + type: 'pages' + values: + layout: 'default' + +# Color scheme supports "light" (default) and "dark" +color_scheme: dark + +exclude: + - .git/ + - .gitignore + - .jekyll-cache/ + - .sass-cache/ + - Gemfile + - Gemfile.lock + - LICENSE + - README.md diff --git a/assets/images/admin-cases.png b/assets/images/admin-cases.png new file mode 100644 index 0000000..e74fb69 Binary files /dev/null and b/assets/images/admin-cases.png differ diff --git a/assets/images/case-ref-search.png b/assets/images/case-ref-search.png new file mode 100644 index 0000000..ebbeb01 Binary files /dev/null and b/assets/images/case-ref-search.png differ diff --git a/assets/images/data-forms-document.png b/assets/images/data-forms-document.png new file mode 100644 index 0000000..79fb66b Binary files /dev/null and b/assets/images/data-forms-document.png differ diff --git a/assets/images/important-dates.png b/assets/images/important-dates.png new file mode 100644 index 0000000..eaa2f43 Binary files /dev/null and b/assets/images/important-dates.png differ diff --git a/assets/images/menu.png b/assets/images/menu.png new file mode 100644 index 0000000..a0102cb Binary files /dev/null and b/assets/images/menu.png differ diff --git a/assets/images/new-case.png b/assets/images/new-case.png new file mode 100644 index 0000000..7c0288f Binary files /dev/null and b/assets/images/new-case.png differ diff --git a/assets/images/quick-navigation-menu.png b/assets/images/quick-navigation-menu.png new file mode 100644 index 0000000..f1167bc Binary files /dev/null and b/assets/images/quick-navigation-menu.png differ diff --git a/assets/images/user-icon.png b/assets/images/user-icon.png new file mode 100644 index 0000000..49fdab6 Binary files /dev/null and b/assets/images/user-icon.png differ diff --git a/case-management/editing-and-closing-a-case.md b/case-management/editing-and-closing-a-case.md new file mode 100644 index 0000000..e723f1d --- /dev/null +++ b/case-management/editing-and-closing-a-case.md @@ -0,0 +1,33 @@ +--- +title: Editing & closing a case +parent: Case Management +nav_order: 2 +--- + +# Editing & closing a case + +The closing of a case is available to the user with admin rights for the workspace. +The admin area can be accessed by clicking on the user icon which produces a menu to select the dashboard. + +After selecting the dashboard, the admin area window will open which has the controls and setup menu for the workspace configuration. + + +[![Menu](/assets/images/user-icon.png)](/assets/images/new-case.png){:target="_blank"} + + +[![Menu](/assets/images/admin-cases.png)](/assets/images/admin-cases.png){:target="_blank"} + +1. Click on the cases icon on the left sidebar menu and the cases screen will open showing a list of the cases which can be sorted by name or case number. + Clicking the pencil / edit icon opens the edit case window and allows the admin to edit the case details. +2. In the edit case window any case setup information can be changed. + There are three sections. + + - **Case Summary** - Enter the date case is opened, opened by, the introducer of the case, the intermediary or organisation if any. + Also enter the case manager, team leader and assistant to the case manager. + - **Case Contact Summary** - In the case summary section, enter the case contact and their details and credentials. + - **Retainer Summary** - In this section there is drop list to allow you to select if the case retainer is quoted on an hourly charge basis or fixed rate. + Enter duration from, which can be any text, eg, 1 day, 2 weeks, 9 months and enter duration to, eg, 4 days, 6 weeks, or 12 months to describe the duration the retainer will take to complete. + An example may be 2 months and 4 months, to describe a retainer duration from 2 to 4 months. + +3. To close a case, in the retainer summary section, enter a closed at date and some text to describe why the case is being closed in the closed reason field. +4. Once the changes are saved, the case will be closed and moved to the closed cases list and removed from open cases. diff --git a/case-management/index.md b/case-management/index.md new file mode 100644 index 0000000..43c118f --- /dev/null +++ b/case-management/index.md @@ -0,0 +1,5 @@ +--- +title: Case Management +--- + +# Case Management diff --git a/case-management/open-a-new-case.md b/case-management/open-a-new-case.md new file mode 100644 index 0000000..a74b866 --- /dev/null +++ b/case-management/open-a-new-case.md @@ -0,0 +1,36 @@ +--- +title: Open a new case +parent: Case Management +nav_order: 1 +--- + +# Open a new case + + +[![Menu](/assets/images/menu.png)](/assets/images/menu.png){:target="_blank"} + +This the case manager menu bar and the first icon "Case" is to open the new case screen. + + +[![New Case](/assets/images/new-case.png)](/assets/images/new-case.png){:target="_blank"} + +The first drop list is workflow and is a required field. + +The available workflows which are activated in the workflow designer will be shown in this list. + +Select the workflow which is required for the case type you are opening from the list and continue to complete the other information for the case. + +1. The workflow drop list displays the activated workflows available for new cases. Select the required workflow to apply to the new case. +2. The new case screen is divided into three section. + + - Case Summary - Enter the date case is opened, opened by, the introducer of the case, the intermediary or organisation if any. + Also enter the case manager, team leader and assistant to the case manager. + - Case Contact Summary - In the case summary section, enter the case contact and their details and credentials. + - Retainer Summary - In this section there is drop list to allow you to select if the case retainer is quoted on an hourly charge basis or fixed rate. + Enter duration from, which can be any text, eg, 1 day, 2 weeks, 9 months and enter duration to, eg, 4 days, 6 weeks, or 12 months to describe the duration the retainer will take to complete. + An example may be 2 months and 4 months, to describe a retainer duration from 2 to 4 months. + +3. There also fields which are user defined to record any other information that you may require. +4. The last two fields are used to record case closure. + The date the case is closed and the reason for closure, such as, case concluded, client did not proceed, or any other reason the case is closed. +5. Click save when you are done and the case will be opened and will be given a case number in the application and appear in the list of cases. diff --git a/case-management/working-on-a-case.md b/case-management/working-on-a-case.md new file mode 100644 index 0000000..0642dd4 --- /dev/null +++ b/case-management/working-on-a-case.md @@ -0,0 +1,39 @@ +--- +title: Working on a case +parent: Case Management +nav_order: 3 +--- + +# Working on a case + + +[![Menu](/assets/images/case-ref-search.png)](/assets/images/case-ref-search.png){:target="_blank"} + +To enter into a case, enter the case number into the search box on the top menu bar and hit return. +You will enter the case on the case dashboard screen. +The case dashboard provides widgets summarising various activities in te case, including task, in tray and out tray items, recent notes and memos. +You will now be able to perform case management actions using all the icons. + + +[![Menu](/assets/images/menu.png)](/assets/images/menu.png){:target="_blank"} + + +[![Menu](/assets/images/quick-navigation-menu.png)](/assets/images/quick-navigation-menu.png){:target="_blank"} + +1. Using the quick navigation you can open the history, data, tasks and notes in the main case panel. +2. Using the main tope menu, you can enter into various case actions, including make memo, make call, send email, set task, and send a letter. +3. Other actions that can be performed from this screen include; + - Inspecting the history of the case which shows the list of actions performed on the case. + - Check the data entered into the case and opening the data forms to enter or edit the case data. + - Reviewing the tasks list and actioning any of the tasks which are due. + - Inspecting the case notes. + + +[![Menu](/assets/images/important-dates.png)](/assets/images/important-dates.png){:target="_blank"} + +The important dates panel shows the dates in the case which have been designated as important in the field setup, and the dates if entered in these fields. + + +[![Menu](/assets/images/data-forms-document.png)](/assets/images/important-dates.png){:target="_blank"} + +The data, forms and document panel will change depending on the item selected, or can be manually selected by clicking on the tabs at the top of the panel. diff --git a/index.md b/index.md new file mode 100644 index 0000000..7228054 --- /dev/null +++ b/index.md @@ -0,0 +1,13 @@ +--- +title: Home +layout: home +nav_order: 0 +--- + +Manage all your administrative activities involved in working on a case, from recording time engaged in preparing documents and forms to making and receiving calls. + +Carry out workflow functions such as sending letters, emails, and SMS messages, and setting and maintaining tasks and reminders. + +Record financial transactions, invoices, credit notes, and payments from office and client accounts. + +Generate global reports for insights into system cases, to assess user activities and billing. diff --git a/package.json b/package.json new file mode 100644 index 0000000..362770d --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "miroshar-case-management-documentation", + "version": "1.0.0", + "description": "miroshar case management documentation", + "main": "index.js", + "scripts": { + "test": "exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/mscm-docs/.github.git" + }, + "keywords": [ + "miroshar", + "case", + "management", + "help", + "documentation" + ], + "author": "Sharaz Khan, James Gates", + "license": "MIT", + "bugs": { + "url": "https://github.com/mscm-docs/.github/issues" + }, + "homepage": "https://github.com/mscm-docs/.github#readme", + "devDependencies": { + "prettier": "^3.3.3" + } +} diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..8c19158 --- /dev/null +++ b/yarn.lock @@ -0,0 +1,8 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +prettier@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105" + integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==