Skip to content
This repository was archived by the owner on Dec 27, 2024. It is now read-only.

Commit bbcc78f

Browse files
committed
chore: update docs
1 parent a037af3 commit bbcc78f

36 files changed

+1683
-18
lines changed

.vscode/settings.json

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"docid",
3333
"dompurify",
3434
"Eesti",
35+
"esnext",
3536
"fileformat",
3637
"fileurl",
3738
"firefox",
@@ -88,6 +89,7 @@
8889
"unregistering",
8990
"upath",
9091
"Uuids",
92+
"vitepress",
9193
"wtlocale",
9294
"yeartexts",
9395
"Ελληνικά",

docs/locales/en.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@
2626
"search": "Search",
2727
"selectText": "to select",
2828
"sidebarMenuLabel": "Menu",
29-
"title": "M³ documentation"
29+
"title": "M³ documentation",
30+
"usingAtAKingdomHall": "Using at a Kingdom Hall"
3031
}
+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Using M³ at a Kingdom Hall
2+
3+
This guide will walk you through the process of downloading, installing, and setting up **Meeting Media Manager (M³)** at a Kingdom Hall. Follow the steps to ensure a smooth setup for managing media during congregation meetings.
4+
5+
## 1. Download and install
6+
7+
1. Visit the [M³ download page](https://github.com/sircharlo/mmm-refactor/releases/latest) and choose the appropriate version for your system (Windows, macOS, or Linux).
8+
2. Once the download is complete, open the installer and follow the on-screen instructions to install M³.
9+
3. After installation, launch M³ to begin the setup process.
10+
11+
## 2. Configuration wizard
12+
13+
### App display language
14+
15+
- When launching M³ for the first time, you will be prompted to choose your preferred **display language**.
16+
- Select the language you want M³ to use for its interface, keeping in mind that media downloads can be set for other languages later.
17+
18+
### Profile type
19+
20+
- The next step is to choose a **profile type**.
21+
- For a regular Kingdom Hall setup, choose **Regular**. This will configure many features that are commonly used for congregation meetings.
22+
23+
> You should only choose **Other** if you are creating a profile for which no media should be automatically downloaded. Media will have to be manually imported for use in this profile. This type of profile is used mostly to use M³ during theocratic schools, assemblies, conventions and other special events. **For normal use during congregation meetings, choose _Regular_.**
24+
25+
### Automatic congregation lookup
26+
27+
- M³ can attempt to automatically find your congregation's meeting schedule, language, and formatted name using publicly available data from the official website of Jehovah's Witnesses.
28+
- To do so, use the **Congregation Lookup** feature and enter at least part of the congregation's name and city.
29+
- Once the correct congregation is found and selected, M³ will prefill all available information, such as your congregation's **name**, **meeting language**, and **meeting days and times**.
30+
31+
### Manual entry of congregation information
32+
33+
- If the automated lookup did not find your congregation, you can of course manually enter the required information.
34+
- The wizard will allow you to review and/or enter your congregation's **name**, **meeting language**, and **meeting days and times**.
35+
36+
### Caching videos from the songbook
37+
38+
- You will be given the option to **cache all videos from the songbook**.
39+
This option pre-downloads all the songbook videos, reducing the time it takes to fetch media for meetings in the future.
40+
- **Pros:** Meeting media will be available much faster.
41+
- **Cons:** The size of the media cache will increase significantly, by approximately 5GB.
42+
- If your Kingdom Hall has sufficient storage space, it’s recommended to enable this option for efficiency and perceived performance.
43+
44+
### OBS Studio Integration Configuration (Optional)
45+
46+
- If your Kingdom Hall uses **OBS Studio** for broadcasting hybrid meetings over Zoom, M³ can automatically integrate with that program.
47+
- During setup, you can configure the integration with OBS Studio by entering the following:
48+
- **Port:** The port number used to connect to the OBS Studio Websocket plugin.
49+
- **Password:** The password used to connect to the OBS Studio Websocket plugin.
50+
- **Scenes:** The OBS scenes that will be used during media presentations. You'll need one scene that captures the media window or screen, and one that shows the stage.
51+
- If your congregation regularly conducts hybrid meetings, it's **highly** recommended to enable the integration with OBS Studio.
52+
53+
## 3. Enjoy using M³
54+
55+
Once the setup wizard is complete, M³ is ready to help manage and present media for congregation meetings. Enjoy using the app!
+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Using M³ at a Kingdom Hall
2+
3+
This guide will walk you through the process of downloading, installing, and setting up **Meeting Media Manager (M³)** at a Kingdom Hall. Follow the steps to ensure a smooth setup for managing media during congregation meetings.
4+
5+
## 1. Download and install
6+
7+
1. Visit the [M³ download page](https://github.com/sircharlo/mmm-refactor/releases/latest) and choose the appropriate version for your system (Windows, macOS, or Linux).
8+
2. Once the download is complete, open the installer and follow the on-screen instructions to install M³.
9+
3. After installation, launch M³ to begin the setup process.
10+
11+
## 2. Configuration wizard
12+
13+
### App display language
14+
15+
- When launching M³ for the first time, you will be prompted to choose your preferred **display language**.
16+
- Select the language you want M³ to use for its interface, keeping in mind that media downloads can be set for other languages later.
17+
18+
### Profile type
19+
20+
- The next step is to choose a **profile type**.
21+
- For a regular Kingdom Hall setup, choose **Regular**. This will configure many features that are commonly used for congregation meetings.
22+
23+
> You should only choose **Other** if you are creating a profile for which no media should be automatically downloaded. Media will have to be manually imported for use in this profile. This type of profile is used mostly to use M³ during theocratic schools, assemblies, conventions and other special events. **For normal use during congregation meetings, choose _Regular_.**
24+
25+
### Automatic congregation lookup
26+
27+
- M³ can attempt to automatically find your congregation's meeting schedule, language, and formatted name using publicly available data from the official website of Jehovah's Witnesses.
28+
- To do so, use the **Congregation Lookup** feature and enter at least part of the congregation's name and city.
29+
- Once the correct congregation is found and selected, M³ will prefill all available information, such as your congregation's **name**, **meeting language**, and **meeting days and times**.
30+
31+
### Manual entry of congregation information
32+
33+
- If the automated lookup did not find your congregation, you can of course manually enter the required information.
34+
- The wizard will allow you to review and/or enter your congregation's **name**, **meeting language**, and **meeting days and times**.
35+
36+
### Caching videos from the songbook
37+
38+
- You will be given the option to **cache all videos from the songbook**.
39+
This option pre-downloads all the songbook videos, reducing the time it takes to fetch media for meetings in the future.
40+
- **Pros:** Meeting media will be available much faster.
41+
- **Cons:** The size of the media cache will increase significantly, by approximately 5GB.
42+
- If your Kingdom Hall has sufficient storage space, it’s recommended to enable this option for efficiency and perceived performance.
43+
44+
### OBS Studio Integration Configuration (Optional)
45+
46+
- If your Kingdom Hall uses **OBS Studio** for broadcasting hybrid meetings over Zoom, M³ can automatically integrate with that program.
47+
- During setup, you can configure the integration with OBS Studio by entering the following:
48+
- **Port:** The port number used to connect to the OBS Studio Websocket plugin.
49+
- **Password:** The password used to connect to the OBS Studio Websocket plugin.
50+
- **Scenes:** The OBS scenes that will be used during media presentations. You'll need one scene that captures the media window or screen, and one that shows the stage.
51+
- If your congregation regularly conducts hybrid meetings, it's **highly** recommended to enable the integration with OBS Studio.
52+
53+
## 3. Enjoy using M³
54+
55+
Once the setup wizard is complete, M³ is ready to help manage and present media for congregation meetings. Enjoy using the app!
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Using M³ at a Kingdom Hall
2+
3+
This guide will walk you through the process of downloading, installing, and setting up **Meeting Media Manager (M³)** at a Kingdom Hall. Follow the steps to ensure a smooth setup for managing media during congregation meetings.
4+
5+
## 1. Download and install
6+
7+
1. Visit the [M³ download page](https://github.com/sircharlo/mmm-refactor/releases/latest) and choose the appropriate version for your system (Windows, macOS, or Linux).
8+
2. Once the download is complete, open the installer and follow the on-screen instructions to install M³.
9+
3. After installation, launch M³ to begin the setup process.
10+
11+
## 2. Configuration wizard
12+
13+
### App display language
14+
15+
- When launching M³ for the first time, you will be prompted to choose your preferred **display language**.
16+
- Select the language you want M³ to use for its interface, keeping in mind that media downloads can be set for other languages later.
17+
18+
### Profile type
19+
20+
- The next step is to choose a **profile type**.
21+
- For a regular Kingdom Hall setup, choose **Regular**. This will configure many features that are commonly used for congregation meetings.
22+
23+
> You should only choose **Other** if you are creating a profile for which no media should be automatically downloaded. Media will have to be manually imported for use in this profile. This type of profile is used mostly to use M³ during theocratic schools, assemblies, conventions and other special events. **For normal use during congregation meetings, choose _Regular_.**
24+
25+
### Automatic congregation lookup
26+
27+
- M³ can attempt to automatically find your congregation's meeting schedule, language, and formatted name using publicly available data from the official website of Jehovah's Witnesses.
28+
- To do so, use the **Congregation Lookup** feature and enter at least part of the congregation's name and city.
29+
- Once the correct congregation is found and selected, M³ will prefill all available information, such as your congregation's **name**, **meeting language**, and **meeting days and times**.
30+
31+
### Manual entry of congregation information
32+
33+
- If the automated lookup did not find your congregation, you can of course manually enter the required information.
34+
- The wizard will allow you to review and/or enter your congregation's **name**, **meeting language**, and **meeting days and times**.
35+
36+
### Caching videos from the songbook
37+
38+
- You will be given the option to **cache all videos from the songbook**.
39+
This option pre-downloads all the songbook videos, reducing the time it takes to fetch media for meetings in the future.
40+
- **Pros:** Meeting media will be available much faster.
41+
- **Cons:** The size of the media cache will increase significantly, by approximately 5GB.
42+
- If your Kingdom Hall has sufficient storage space, it’s recommended to enable this option for efficiency and perceived performance.
43+
44+
### OBS Studio Integration Configuration (Optional)
45+
46+
- If your Kingdom Hall uses **OBS Studio** for broadcasting hybrid meetings over Zoom, M³ can automatically integrate with that program.
47+
- During setup, you can configure the integration with OBS Studio by entering the following:
48+
- **Port:** The port number used to connect to the OBS Studio Websocket plugin.
49+
- **Password:** The password used to connect to the OBS Studio Websocket plugin.
50+
- **Scenes:** The OBS scenes that will be used during media presentations. You'll need one scene that captures the media window or screen, and one that shows the stage.
51+
- If your congregation regularly conducts hybrid meetings, it's **highly** recommended to enable the integration with OBS Studio.
52+
53+
## 3. Enjoy using M³
54+
55+
Once the setup wizard is complete, M³ is ready to help manage and present media for congregation meetings. Enjoy using the app!
+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Using M³ at a Kingdom Hall
2+
3+
This guide will walk you through the process of downloading, installing, and setting up **Meeting Media Manager (M³)** at a Kingdom Hall. Follow the steps to ensure a smooth setup for managing media during congregation meetings.
4+
5+
## 1. Download and install
6+
7+
1. Visit the [M³ download page](https://github.com/sircharlo/mmm-refactor/releases/latest) and choose the appropriate version for your system (Windows, macOS, or Linux).
8+
2. Once the download is complete, open the installer and follow the on-screen instructions to install M³.
9+
3. After installation, launch M³ to begin the setup process.
10+
11+
## 2. Configuration wizard
12+
13+
### App display language
14+
15+
- When launching M³ for the first time, you will be prompted to choose your preferred **display language**.
16+
- Select the language you want M³ to use for its interface, keeping in mind that media downloads can be set for other languages later.
17+
18+
### Profile type
19+
20+
- The next step is to choose a **profile type**.
21+
- For a regular Kingdom Hall setup, choose **Regular**. This will configure many features that are commonly used for congregation meetings.
22+
23+
> You should only choose **Other** if you are creating a profile for which no media should be automatically downloaded. Media will have to be manually imported for use in this profile. This type of profile is used mostly to use M³ during theocratic schools, assemblies, conventions and other special events. **For normal use during congregation meetings, choose _Regular_.**
24+
25+
### Automatic congregation lookup
26+
27+
- M³ can attempt to automatically find your congregation's meeting schedule, language, and formatted name using publicly available data from the official website of Jehovah's Witnesses.
28+
- To do so, use the **Congregation Lookup** feature and enter at least part of the congregation's name and city.
29+
- Once the correct congregation is found and selected, M³ will prefill all available information, such as your congregation's **name**, **meeting language**, and **meeting days and times**.
30+
31+
### Manual entry of congregation information
32+
33+
- If the automated lookup did not find your congregation, you can of course manually enter the required information.
34+
- The wizard will allow you to review and/or enter your congregation's **name**, **meeting language**, and **meeting days and times**.
35+
36+
### Caching videos from the songbook
37+
38+
- You will be given the option to **cache all videos from the songbook**.
39+
This option pre-downloads all the songbook videos, reducing the time it takes to fetch media for meetings in the future.
40+
- **Pros:** Meeting media will be available much faster.
41+
- **Cons:** The size of the media cache will increase significantly, by approximately 5GB.
42+
- If your Kingdom Hall has sufficient storage space, it’s recommended to enable this option for efficiency and perceived performance.
43+
44+
### OBS Studio Integration Configuration (Optional)
45+
46+
- If your Kingdom Hall uses **OBS Studio** for broadcasting hybrid meetings over Zoom, M³ can automatically integrate with that program.
47+
- During setup, you can configure the integration with OBS Studio by entering the following:
48+
- **Port:** The port number used to connect to the OBS Studio Websocket plugin.
49+
- **Password:** The password used to connect to the OBS Studio Websocket plugin.
50+
- **Scenes:** The OBS scenes that will be used during media presentations. You'll need one scene that captures the media window or screen, and one that shows the stage.
51+
- If your congregation regularly conducts hybrid meetings, it's **highly** recommended to enable the integration with OBS Studio.
52+
53+
## 3. Enjoy using M³
54+
55+
Once the setup wizard is complete, M³ is ready to help manage and present media for congregation meetings. Enjoy using the app!
+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Using M³ at a Kingdom Hall
2+
3+
This guide will walk you through the process of downloading, installing, and setting up **Meeting Media Manager (M³)** at a Kingdom Hall. Follow the steps to ensure a smooth setup for managing media during congregation meetings.
4+
5+
## 1. Download and install
6+
7+
1. Visit the [M³ download page](https://github.com/sircharlo/mmm-refactor/releases/latest) and choose the appropriate version for your system (Windows, macOS, or Linux).
8+
2. Once the download is complete, open the installer and follow the on-screen instructions to install M³.
9+
3. After installation, launch M³ to begin the setup process.
10+
11+
## 2. Configuration wizard
12+
13+
### App display language
14+
15+
- When launching M³ for the first time, you will be prompted to choose your preferred **display language**.
16+
- Select the language you want M³ to use for its interface, keeping in mind that media downloads can be set for other languages later.
17+
18+
### Profile type
19+
20+
- The next step is to choose a **profile type**.
21+
- For a regular Kingdom Hall setup, choose **Regular**. This will configure many features that are commonly used for congregation meetings.
22+
23+
> You should only choose **Other** if you are creating a profile for which no media should be automatically downloaded. Media will have to be manually imported for use in this profile. This type of profile is used mostly to use M³ during theocratic schools, assemblies, conventions and other special events. **For normal use during congregation meetings, choose _Regular_.**
24+
25+
### Automatic congregation lookup
26+
27+
- M³ can attempt to automatically find your congregation's meeting schedule, language, and formatted name using publicly available data from the official website of Jehovah's Witnesses.
28+
- To do so, use the **Congregation Lookup** feature and enter at least part of the congregation's name and city.
29+
- Once the correct congregation is found and selected, M³ will prefill all available information, such as your congregation's **name**, **meeting language**, and **meeting days and times**.
30+
31+
### Manual entry of congregation information
32+
33+
- If the automated lookup did not find your congregation, you can of course manually enter the required information.
34+
- The wizard will allow you to review and/or enter your congregation's **name**, **meeting language**, and **meeting days and times**.
35+
36+
### Caching videos from the songbook
37+
38+
- You will be given the option to **cache all videos from the songbook**.
39+
This option pre-downloads all the songbook videos, reducing the time it takes to fetch media for meetings in the future.
40+
- **Pros:** Meeting media will be available much faster.
41+
- **Cons:** The size of the media cache will increase significantly, by approximately 5GB.
42+
- If your Kingdom Hall has sufficient storage space, it’s recommended to enable this option for efficiency and perceived performance.
43+
44+
### OBS Studio Integration Configuration (Optional)
45+
46+
- If your Kingdom Hall uses **OBS Studio** for broadcasting hybrid meetings over Zoom, M³ can automatically integrate with that program.
47+
- During setup, you can configure the integration with OBS Studio by entering the following:
48+
- **Port:** The port number used to connect to the OBS Studio Websocket plugin.
49+
- **Password:** The password used to connect to the OBS Studio Websocket plugin.
50+
- **Scenes:** The OBS scenes that will be used during media presentations. You'll need one scene that captures the media window or screen, and one that shows the stage.
51+
- If your congregation regularly conducts hybrid meetings, it's **highly** recommended to enable the integration with OBS Studio.
52+
53+
## 3. Enjoy using M³
54+
55+
Once the setup wizard is complete, M³ is ready to help manage and present media for congregation meetings. Enjoy using the app!

0 commit comments

Comments
 (0)