diff --git a/.gitignore b/.gitignore
index c38ceb8..1d1f900 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,11 +6,14 @@
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
_site/
-.sass-cache/
.jekyll-cache/
.jekyll-metadata
+.sass-cache/
# Ignore folders generated by Bundler
.bundle/
-vendor/
node_modules/
+vendor/
+
+# Ignore files
+*.psd
diff --git a/_config.yml b/_config.yml
index 8b4606c..c6153d1 100644
--- a/_config.yml
+++ b/_config.yml
@@ -1,12 +1,9 @@
-title: mscm docs
+title: miroshar case management documentation
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
-
+baseurl: ''
url: https://mscm-docs.github.io/
-aux_links:
- 'on GitHub': https://github.com/mscm-docs/mscm-docs.github.io
-
permalink: pretty
defaults:
@@ -27,4 +24,74 @@ exclude:
- Gemfile
- Gemfile.lock
- LICENSE
+ - node_modules/
+ - package.json
- README.md
+ - yarn.lock
+
+# Set a path/url to a logo that will be displayed instead of the title
+#logo: "/assets/images/just-the-docs.png"
+
+# Enable or disable the site search
+# Supports true (default) or false
+search_enabled: true
+search:
+ # Split pages into sections that can be searched individually
+ # Supports 1 - 6, default: 2
+ heading_level: 6
+ # Maximum amount of previews per search result
+ # Default: 3
+ previews: 3
+ # Maximum amount of words to display before a matched word in the preview
+ # Default: 5
+ preview_words_before: 5
+ # Maximum amount of words to display after a matched word in the preview
+ # Default: 10
+ preview_words_after: 10
+ # Set the search token separator
+ # Default: /[\s\-/]+/
+ # Example: enable support for hyphenated search words
+ tokenizer_separator: /[\s/]+/
+ # Display the relative url in search results
+ # Supports true (default) or false
+ rel_url: true
+ # Enable or disable the search button that appears in the bottom right corner of every page
+ # Supports true or false (default)
+ button: false
+ # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
+ focus_shortcut_key: 'k'
+
+# For copy button on code
+enable_copy_code_button: true
+
+# Aux links for the upper right navigation
+aux_links:
+ #'on GitHub': https://github.com/mscm-docs/mscm-docs.github.io
+
+# Makes Aux links open in a new tab. Default is false
+aux_links_new_tab: true
+
+# Enable or disable the side/mobile menu globally
+# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
+nav_enabled: true
+
+# Back to top link
+back_to_top: true
+back_to_top_text: 'Back to top'
+
+# Footer content
+# appears at the bottom of every page's main content
+
+footer_content: 'Copyright © 2024 miroshar. Distributed by an MIT license. This site is powered by Just the Docs.'
+
+# Footer last edited timestamp
+last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
+last_edit_time_format: '%b %e %Y at %I:%M %p' # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: 'Edit this page on GitHub'
+gh_edit_repository: 'https://github.com/mscm-docs/mscm-docs.github.io' # the github URL for your repo
+gh_edit_branch: 'main' # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: 'tree' # "tree" or "edit" if you want the user to jump into the editor immediately
diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss
new file mode 100644
index 0000000..4dbb249
--- /dev/null
+++ b/_sass/custom/custom.scss
@@ -0,0 +1,11 @@
+@media (min-width: 50rem) {
+ .side-bar .site-header .site-title {
+ font-size: 1rem !important;
+ }
+}
+
+.site-nav .nav-list .nav-list-item .nav-list-link {
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
diff --git a/assets/images/add-remove-attachments.png b/assets/images/add-remove-attachments.png
new file mode 100644
index 0000000..f18e619
Binary files /dev/null and b/assets/images/add-remove-attachments.png differ
diff --git a/assets/images/attachment-list.png b/assets/images/attachment-list.png
new file mode 100644
index 0000000..1406e72
Binary files /dev/null and b/assets/images/attachment-list.png differ
diff --git a/assets/images/menu-4-case.png b/assets/images/menu-4-case.png
new file mode 100644
index 0000000..c0a0aac
Binary files /dev/null and b/assets/images/menu-4-case.png differ
diff --git a/assets/images/menu-4-letter.png b/assets/images/menu-4-letter.png
new file mode 100644
index 0000000..81eba75
Binary files /dev/null and b/assets/images/menu-4-letter.png differ
diff --git a/assets/images/menu.png b/assets/images/menu.png
index a0102cb..5a94621 100644
Binary files a/assets/images/menu.png and b/assets/images/menu.png differ
diff --git a/assets/images/new-case.png b/assets/images/new-case.png
index 7c0288f..aea7ad7 100644
Binary files a/assets/images/new-case.png and b/assets/images/new-case.png differ
diff --git a/assets/images/send-letter-buttons.png b/assets/images/send-letter-buttons.png
new file mode 100644
index 0000000..a99d341
Binary files /dev/null and b/assets/images/send-letter-buttons.png differ
diff --git a/assets/images/send-letter.png b/assets/images/send-letter.png
new file mode 100644
index 0000000..a201e01
Binary files /dev/null and b/assets/images/send-letter.png differ
diff --git a/case-management/editing-and-closing-a-case.md b/case-management/editing-and-closing-a-case.md
index e723f1d..3fc6651 100644
--- a/case-management/editing-and-closing-a-case.md
+++ b/case-management/editing-and-closing-a-case.md
@@ -12,10 +12,10 @@ The admin area can be accessed by clicking on the user icon which produces a men
After selecting the dashboard, the admin area window will open which has the controls and setup menu for the workspace configuration.
-[](/assets/images/new-case.png){:target="_blank"}
+[](/assets/images/user-icon.png){:target="_blank"}
-[](/assets/images/admin-cases.png){:target="_blank"}
+[](/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.
diff --git a/case-management/index.md b/case-management/index.md
index 43c118f..62117eb 100644
--- a/case-management/index.md
+++ b/case-management/index.md
@@ -1,5 +1,6 @@
---
title: Case Management
+nav_order: 1
---
# Case Management
diff --git a/case-management/open-a-new-case.md b/case-management/open-a-new-case.md
index a74b866..e3f2189 100644
--- a/case-management/open-a-new-case.md
+++ b/case-management/open-a-new-case.md
@@ -7,7 +7,7 @@ nav_order: 1
# Open a new case
-[](/assets/images/menu.png){:target="_blank"}
+[](/assets/images/menu-4-case.png){:target="_blank"}
This the case manager menu bar and the first icon "Case" is to open the new case screen.
@@ -23,10 +23,10 @@ Select the workflow which is required for the case type you are opening from the
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.
+ - **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.
+ - **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.
diff --git a/case-management/working-on-a-case.md b/case-management/working-on-a-case.md
index 0642dd4..56497df 100644
--- a/case-management/working-on-a-case.md
+++ b/case-management/working-on-a-case.md
@@ -7,7 +7,7 @@ nav_order: 3
# Working on a case
-[](/assets/images/case-ref-search.png){:target="_blank"}
+[](/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.
@@ -18,7 +18,7 @@ You will now be able to perform case management actions using all the icons.
[](/assets/images/menu.png){:target="_blank"}
-[](/assets/images/quick-navigation-menu.png){:target="_blank"}
+[](/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.
@@ -29,11 +29,11 @@ You will now be able to perform case management actions using all the icons.
- Inspecting the case notes.
-[](/assets/images/important-dates.png){:target="_blank"}
+[](/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.
-[](/assets/images/important-dates.png){:target="_blank"}
+[](/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/communication-and-documentation/index.md b/communication-and-documentation/index.md
new file mode 100644
index 0000000..f675494
--- /dev/null
+++ b/communication-and-documentation/index.md
@@ -0,0 +1,6 @@
+---
+title: Communication & Documentation
+nav_order: 2
+---
+
+# Communication & Documentation
diff --git a/communication-and-documentation/sending-and-saving-correspondence/index.md b/communication-and-documentation/sending-and-saving-correspondence/index.md
new file mode 100644
index 0000000..48ef8ae
--- /dev/null
+++ b/communication-and-documentation/sending-and-saving-correspondence/index.md
@@ -0,0 +1,7 @@
+---
+title: Sending & Saving Correspondence
+parent: Communication & Documentation
+nav_order: 1
+---
+
+# Sending & Saving Correspondence
diff --git a/communication-and-documentation/sending-and-saving-correspondence/send-a-letter.md b/communication-and-documentation/sending-and-saving-correspondence/send-a-letter.md
new file mode 100644
index 0000000..e6ce7ce
--- /dev/null
+++ b/communication-and-documentation/sending-and-saving-correspondence/send-a-letter.md
@@ -0,0 +1,47 @@
+---
+title: Send a letter & save with attachments
+parent: Sending & Saving Correspondence
+nav_order: 1
+---
+
+# Send a letter & save with attachments
+
+
+[](/assets/images/menu-4-letter.png){:target="_blank"}
+
+Sending an adhoc letter not connected in anyway to the workflow can be done by clicking on the letter icon.
+The send letter screen will open and will show the case name and number for which the send letter action is being performed.
+
+
+[](/assets/images/send-letter.png){:target="_blank"}
+
+The template letters are categorised by contact types which are setup by admin and in the fields setup.
+The contact drop list will be populated with the contact types with the names of the contact entered into the database.
+
+1. Select the contact to who you wish to send a letter.
+2. From the template drop list, select from the list of templates setup in the workflow setup for that contact.
+3. The contact reference entered into the contact data will be populated, and the detail will be populated with the template name and description.
+
+
+[](/assets/images/send-letter-buttons.png){:target="_blank"}
+
+Using the buttons the letter can be saved to the history, edited or cancelled.
+Attachments can also be added to the letter from the document items in the history of the case.
+
+1. **Save** - The letter will be saved to the history without any editing, but the letter item will be available for editing for up to 48 hours after this time the letter will be locked.
+ After this time when the letter is locked it cannot be edited, the letter can be generated from the template again and edited, printed and saved to the history.
+2. **Attachments** - This button will open an attachments window and will show a list of the history items, documents and letters.
+ The list can be searched by entering the search criteria or text and clicking the search icon and double clicking on a document will display the document in the preview panel.
+ The checkbox at the side of the items list will mark the item to be added to the letter as an attachment.
+
+
+ [](/assets/images/attachment-list.png){:target="\_blank"}
+
+
+ [](/assets/images/add-remove-attachments.png){:target="\_blank"}
+
+3. Click the down arrow to move the marked items into the attachments panel.
+4. Clicking the checkboxes next to the documents in the attachments panel marks them and clicking the up arrow will move them out of the attachments panel.
+5. Click save to save the attachments to the document.
+6. Click edit to open the document editor to edit the document.
+7. Click save to save the document to the case history.
diff --git a/index.md b/index.md
index 76c5154..d5517f7 100644
--- a/index.md
+++ b/index.md
@@ -1,8 +1,10 @@
---
-title: Home
+title: Welcome
nav_order: 0
---
+# Welcome to miroshar case management system
+
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.