From c487ded7b6e0f33f8078c3ff07507a2edbbe751e Mon Sep 17 00:00:00 2001 From: meichthys Date: Mon, 3 Nov 2025 03:12:10 +0000 Subject: [PATCH] Update documentation with document naming clarification --- .../workspace/getting_started/getting_started.json | 4 ++-- church/church_foundations/workspace/support/support.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/church/church_foundations/workspace/getting_started/getting_started.json b/church/church_foundations/workspace/getting_started/getting_started.json index 74a7dae..60d9299 100644 --- a/church/church_foundations/workspace/getting_started/getting_started.json +++ b/church/church_foundations/workspace/getting_started/getting_started.json @@ -1,6 +1,6 @@ { "charts": [], - "content": "[{\"id\":\"jBOqYlrUKi\",\"type\":\"header\",\"data\":{\"text\":\"Getting Started\",\"col\":12}},{\"id\":\"G96Ym-p_M3\",\"type\":\"onboarding\",\"data\":{\"onboarding_name\":\"Church\",\"col\":12}},{\"id\":\"-4rZfnKx88\",\"type\":\"paragraph\",\"data\":{\"text\":\"\ud83d\udd20Terminology\",\"col\":12}},{\"id\":\"DbBYvDiV8I\",\"type\":\"paragraph\",\"data\":{\"text\":\"- Workspace: Each menu item to the left is called a 'Workspace'. Workspaces show the Documents, Reports, and other ways you can with in the module.
- Module: A group of related functions in the app (i.e, Donations, Funds, Expenses).
- Document: Data that describes an object (i.e. Song, Fund, Person, etc). Documents are composed of pieces of data called 'Fields'. Documents are created via 'Forms' and can be viewed in a Document 'List' or Document 'Report'.
    - States: When a Document is created, it can be in various states:
        - Not Saved: A new document is in this state until it is saved. No data is retained until the document is saved.
        - Draft: The document has not been submitted yet. Submittable documents will be in the 'draft' state after they are saved and before they are submitted. In this state the document can still be modified.
        - Submitted: A finalized document which cannot be edited unless it is cancelled and amended.
        - Cancelled: A document that has been cancelled (as opposed to deleted). Cancelled documents remain in the system for reference, and can be amended and re-submitted.
        - Amended: If a cancelled document needs to be changed, it can be amended. This will create a new document which will be linked to the original (cancelled) document.
- Fields: Pieces of data that make up a document (i.e. Name, Age, etc). Fields with a red * are mandatory.
- Form: A way to enter data into the system. A form consists of any number of fields, that (when saved) create a document.
- List: A view that shows documents in a vertical layout. You can view a list of any type of document by typing `DocumentName List` in the search bar at the top of the page.
- Report: A view that shows documents in an easy-to-filter view. Every column can be filtered individually. Additional filters and groupings can be added to easily retrieve a subset of documents.\",\"col\":12}},{\"id\":\"Yx5-uyqasy\",\"type\":\"paragraph\",\"data\":{\"text\":\"\ud83d\udcccGeneral App Tips\",\"col\":12}},{\"id\":\"oyG93LCEUd\",\"type\":\"paragraph\",\"data\":{\"text\":\"The general layout of the application is the same for most modules & documents. Once you learn how to interact with the system in one module, it will be almost identical in other modules. Some tips that will work across the application are:\",\"col\":12}},{\"id\":\"d9OEtT2hpG\",\"type\":\"paragraph\",\"data\":{\"text\":\"Awesome Bar (keyboard shortcut of `ctrl-g`)
The search bar at the top of the page is called the `Awesome Bar` because it can be used for many purposes:
\u2795 Creating a new document: (i.e. `New Church Person` to add a new church person into the app)
\ud83d\udccbListing all documents of a specific type: (i.e. `Church Person List` to show a list of existing church people)
\ud83d\udcc4Report of a specific document type: (i.e. `Church Person Report` \\nto show a filter-able and group-able report containing church people)
\ud83d\udd0dFind an individual document: (i.e. `Marjorie May` to search for this person. Most documents are searchable this way)\",\"col\":12}},{\"id\":\"MJLiY1t4dT\",\"type\":\"paragraph\",\"data\":{\"text\":\"Navigation
To navigate the system you can use the following:
\u2b05\ufe0f The sidebar items on the left will take you to a workspace for the given module
\u2196\ufe0f Clicking on the icon on the top left will take you back to the default workspace page.
\u2197\ufe0f Using the search bar, you can navigate to almost any page in the app.\",\"col\":12}},{\"id\":\"wDz7rjHAKG\",\"type\":\"paragraph\",\"data\":{\"text\":\"Keyboard Shortcuts
After using the app for a while, keyboard shortcuts can help speed up your workflow significantly. To view a list of keyboard shortcuts, click the `Help > Keyboard Shortcuts` at the top right of the page. Some common shortcuts that may be useful are:
\ud83d\udcbe `ctrl-s` Saves a loaded document/form
\ud83d\udccd`ctrl-j` Locates a specific field in a form
\ud83d\udd0d`ctrl-g` Focuses the AwesomeBar for quick access to almost any action in the app.
\ud83d\udd03`ctrl-shift-r` Reloads the page - Useful if something didn't seem to load correctly.\",\"col\":12}}]", + "content": "[{\"id\":\"jBOqYlrUKi\",\"type\":\"header\",\"data\":{\"text\":\"Getting Started\",\"col\":12}},{\"id\":\"G96Ym-p_M3\",\"type\":\"onboarding\",\"data\":{\"onboarding_name\":\"Church\",\"col\":12}},{\"id\":\"-4rZfnKx88\",\"type\":\"paragraph\",\"data\":{\"text\":\"\ud83d\udcacTerminology\",\"col\":12}},{\"id\":\"DbBYvDiV8I\",\"type\":\"paragraph\",\"data\":{\"text\":\"- Workspace: Each menu item to the left is called a 'Workspace'. Workspaces show the Documents, Reports, and other ways you can with in the module.
- Module: A group of related functions in the app (i.e, Donations, Funds, Expenses).
- Document: Data that describes an object (i.e. Song, Fund, Person, etc). Documents are composed of 'Fields', are created via 'Forms', and can be viewed in a Document 'List' or 'Report'.
    - Name: The title given to a document. Some documents may have a number after the name to prevent documents from having the same name (document names must be unique).
    - State: When a Document is created, it can be in various states:
        - Not Saved: A new document is in this state until it is saved. No data is retained until the document is saved.
        - Draft: The document has not been submitted yet. Submittable documents will be in the 'draft' state after they are saved and before they are submitted. In this state the document can still be modified.
        - Submitted: A finalized document which cannot be edited unless it is cancelled and amended.
        - Cancelled: A document that has been cancelled (as opposed to deleted). Cancelled documents remain in the system for reference, and can be amended and re-submitted.
        - Amended: If a cancelled document needs to be changed, it can be amended. This will create a new document which will be linked to the original (cancelled) document.
- Fields: Pieces of data that make up a document (i.e. Name, Age, etc). Fields with a red * are mandatory.
- Form: A way to enter data into the system. A form consists of any number of fields, that (when saved) create a document.
- List: A view that shows documents in a vertical layout. You can view a list of any type of document by typing `DocumentName List` in the search bar at the top of the page.
- Report: A view that shows documents in an easy-to-filter view. Every column can be filtered individually. Additional filters and groupings can be added to easily retrieve a subset of documents.\",\"col\":12}},{\"id\":\"Yx5-uyqasy\",\"type\":\"paragraph\",\"data\":{\"text\":\"\ud83d\udcccGeneral App Tips\",\"col\":12}},{\"id\":\"oyG93LCEUd\",\"type\":\"paragraph\",\"data\":{\"text\":\"The general layout of the application is the same for most modules & documents. Once you learn how to interact with the system in one module, it will be almost identical in other modules. Some tips that will work across the application are:\",\"col\":12}},{\"id\":\"d9OEtT2hpG\",\"type\":\"paragraph\",\"data\":{\"text\":\"Awesome Bar (keyboard shortcut of `ctrl-g`)
The search bar at the top of the page is called the `Awesome Bar` because it can be used for many purposes:
\u2795 Creating a new document: (i.e. `New Church Person` to add a new church person into the app)
\ud83d\udccbListing all documents of a specific type: (i.e. `Church Person List` to show a list of existing church people)
\ud83d\udcc4Report of a specific document type: (i.e. `Church Person Report` \\nto show a filter-able and group-able report containing church people)
\ud83d\udd0dFind an individual document: (i.e. `Marjorie May` to search for this person. Most documents are searchable this way)\",\"col\":12}},{\"id\":\"MJLiY1t4dT\",\"type\":\"paragraph\",\"data\":{\"text\":\"Navigation
To navigate the system you can use the following:
\u2b05\ufe0f The sidebar items on the left will take you to a workspace for the given module
\u2196\ufe0f Clicking on the icon on the top left will take you back to the default workspace page.
\u2197\ufe0f Using the search bar, you can navigate to almost any page in the app.\",\"col\":12}},{\"id\":\"wDz7rjHAKG\",\"type\":\"paragraph\",\"data\":{\"text\":\"Keyboard Shortcuts
After using the app for a while, keyboard shortcuts can help speed up your workflow significantly. To view a list of keyboard shortcuts, click the `Help > Keyboard Shortcuts` at the top right of the page. Some common shortcuts that may be useful are:
\ud83d\udcbe `ctrl-s` Saves a loaded document/form
\ud83d\udccd`ctrl-j` Locates a specific field in a form
\ud83d\udd0d`ctrl-g` Focuses the AwesomeBar for quick access to almost any action in the app.
\ud83d\udd03`ctrl-shift-r` Reloads the page - Useful if something didn't seem to load correctly.\",\"col\":12}}]", "creation": "2025-10-20 23:30:01.238945", "custom_blocks": [], "docstatus": 0, @@ -13,7 +13,7 @@ "is_hidden": 0, "label": "Getting Started", "links": [], - "modified": "2025-11-01 23:38:52.296309", + "modified": "2025-11-02 22:09:54.766176", "modified_by": "Administrator", "module": "Church Foundations", "name": "Getting Started", diff --git a/church/church_foundations/workspace/support/support.json b/church/church_foundations/workspace/support/support.json index df473a2..4175fe8 100644 --- a/church/church_foundations/workspace/support/support.json +++ b/church/church_foundations/workspace/support/support.json @@ -1,6 +1,6 @@ { "charts": [], - "content": "[{\"id\":\"42bOdD9xyC\",\"type\":\"header\",\"data\":{\"text\":\"\ud83c\udd98Support\",\"col\":12}},{\"id\":\"pJyhpxlSjA\",\"type\":\"paragraph\",\"data\":{\"text\":\"If you have issues or suggestions, please report them to the 'Church' GitHub repository.
If you do not have a GitHub account or if you need help, connect with us on our Matrix Chat\ud83d\udcac.\",\"col\":12}},{\"id\":\"CHRf80k2is\",\"type\":\"header\",\"data\":{\"text\":\"\u2753FAQ\",\"col\":12}},{\"id\":\"rUk2y7CBCh\",\"type\":\"paragraph\",\"data\":{\"text\":\"Why is this free? Is there a catch?: There's no catch. The application is free in its entirety (apart from hosting costs). The original developer was saddened to see businesses profiting off of a need for churches to be organized. The global church body should be able to support itself in all areas via the talents and generosity of it's members.

Can I customize the default drop-down options?: Yes, most drop-down lists should give you an option to 'Create New <Document>'. Clicking this option will allow you to add an additional option to the drop-down list for future use. In fact, the system is entirely customizable to the Administrator account, to the point where you can create new 'DocTypes', Reports, Workflows, Webpages, etc. If you have ideas for improvements that other churches could use, you can report them to our github repository.\",\"col\":12}}]", + "content": "[{\"id\":\"42bOdD9xyC\",\"type\":\"header\",\"data\":{\"text\":\"\ud83d\udedfSupport\",\"col\":12}},{\"id\":\"pJyhpxlSjA\",\"type\":\"paragraph\",\"data\":{\"text\":\"If you have issues or suggestions, please report them to the 'Church' GitHub repository.
If you do not have a GitHub account or if you need help, connect with us on our Matrix Chat\ud83d\udcac.\",\"col\":12}},{\"id\":\"CHRf80k2is\",\"type\":\"header\",\"data\":{\"text\":\"\u2753FAQ\",\"col\":12}},{\"id\":\"rUk2y7CBCh\",\"type\":\"paragraph\",\"data\":{\"text\":\"- Why is this free? Is there a catch?: There's no catch. The application is free in its entirety (apart from hosting costs). The original developer was saddened to see businesses profiting off of a need for churches to be organized. The global church body should be able to support itself in all areas via the talents and generosity of it's members.

- Can I customize the default drop-down options?: Yes, most drop-down lists should give you an option to 'Create New <Document>'. Clicking this option will allow you to add an additional option to the drop-down list for future use. In fact, the system is entirely customizable to the Administrator account, to the point where you can create new 'DocTypes', Reports, Workflows, Webpages, etc. If you have ideas for improvements that other churches could use, you can report them to our github repository.\",\"col\":12}}]", "creation": "2025-10-20 22:50:30.675476", "custom_blocks": [], "docstatus": 0, @@ -13,7 +13,7 @@ "is_hidden": 0, "label": "Support", "links": [], - "modified": "2025-11-01 23:09:50.562756", + "modified": "2025-11-02 22:09:14.841684", "modified_by": "Administrator", "module": "Church Foundations", "name": "Support",