diff --git a/README.md b/README.md index 18f7d8cb..7b0c81ea 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ [![sunrise-cms](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/26a4bi&style=flat&logo=cypress)](https://cloud.cypress.io/projects/26a4bi/runs) [![Coverage Testing](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml) -![Sunrise CMS](./docs/socialPreview.png) +![Sunrise CMS](./docs/images/socialPreview.png) 🚧 **In development** 🚧 **A web-based application to assist cemetery managers with managing their cemetery records.** -![Burial Site View](./docs/burialSite-view.png) +![Burial Site View](./docs/images/burialSite-view.png) This is a major refactoring of the now archived [Lot Occupancy System](https://github.com/cityssm/lot-occupancy-system), diff --git a/docs/README.md b/docs/README.md index a893a573..a613d841 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ **Thank you for taking the time to read the Sunrise Cemetery Management System (CMS) documentation.** -![Burial Site View](./burialSite-view.png) +![Burial Site View](./images/burialSite-view.png) **In development** diff --git a/docs/burialSites.md b/docs/burialSites.md index 660ef1c9..d5db6a68 100644 --- a/docs/burialSites.md +++ b/docs/burialSites.md @@ -3,3 +3,20 @@ [Help](https://cityssm.github.io/sunrise-cms/docs/) # Burial Sites + +![Burial Site Update View](./images/burialSite-update.png) + +Burial sites are the locations within [cemeteries](./cemeteries.md) where interments take place. + +## Key Burial Site Fields + +**Burial Site Name**
+Can be up to five segments, each with their own requirements. +Can be prepended with the cemetery key. +Must be unique system wide. + +**Geographic Location**
+Used to show the burial site location on a map. + +**Cemetery SVG ID**
+Used to highlight the burial site within the cemetery's SVG image. diff --git a/docs/cemeteries.md b/docs/cemeteries.md index 4827ceda..7c22b83d 100644 --- a/docs/cemeteries.md +++ b/docs/cemeteries.md @@ -3,3 +3,21 @@ [Help](https://cityssm.github.io/sunrise-cms/docs/) # Cemeteries + +![Update Cemetery View](./images/cemetery-update.png) + +Cemeteries are groupings of [burial sites](./burialSites.md). + +## Key Cemetery Fields + +**Cemetery Key**
+Can be prepended to burial site names. + +**Parent Cemetery**
+Helpful when breaking larger cemeteries into smaller sections. + +**Geographic Location**
+Used to show the cemetery location on a map. + +**Image**
+An SVG image of the cemetery, optional labelled to allow for burial site highlighting. diff --git a/docs/contracts.md b/docs/contracts.md index 8f0200d3..438f0102 100644 --- a/docs/contracts.md +++ b/docs/contracts.md @@ -3,3 +3,17 @@ [Help](https://cityssm.github.io/sunrise-cms/docs/) # Contracts + +![Contract Update View](./images/contract-update.png) + +Contracts track preneed [burial site](./burialSites.md) reservations, +and at-need burial site interments. + +## Key Contract Fields + +**End Date**
+When set, the end date is considered the date the contract no longer applies. +In the case of a preneed contract, an end date should be applied when the recipient passes +and is interred in the burial site. +In the case of an at-need contract, the end date should remain empty as long as the deceased +is interred in the burial site. diff --git a/docs/images/burialSite-update.png b/docs/images/burialSite-update.png new file mode 100644 index 00000000..58f89a2f Binary files /dev/null and b/docs/images/burialSite-update.png differ diff --git a/docs/burialSite-view.png b/docs/images/burialSite-view.png similarity index 100% rename from docs/burialSite-view.png rename to docs/images/burialSite-view.png diff --git a/docs/images/cemetery-update.png b/docs/images/cemetery-update.png new file mode 100644 index 00000000..058de071 Binary files /dev/null and b/docs/images/cemetery-update.png differ diff --git a/docs/images/contract-update.png b/docs/images/contract-update.png new file mode 100644 index 00000000..65c3420f Binary files /dev/null and b/docs/images/contract-update.png differ diff --git a/docs/socialPreview.png b/docs/images/socialPreview.png similarity index 100% rename from docs/socialPreview.png rename to docs/images/socialPreview.png