Fix some typos in the documentation (#18)

omnt · Jul 4, 2024 · e762747 · e762747
1 parent 6203572
commit e762747
Show file tree

Hide file tree

Showing 16 changed files with 22 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 ## Release [0.3]
 
 ### Added
-- Github Action Workflow for APK Debug/Relase Build and SPDX File [PR 13](https://github.com/omnt/OpenMobileNetworkToolkit/pull/13)
+- Github Action Workflow for APK Debug/Release Build and SPDX File [PR 13](https://github.com/omnt/OpenMobileNetworkToolkit/pull/13)
 - Documentation [PR 13](https://github.com/omnt/OpenMobileNetworkToolkit/pull/13)
 - CHANGELOG.md [PR 13](https://github.com/omnt/OpenMobileNetworkToolkit/pull/13)
 

diff --git a/docs/android_tweaks.md b/docs/android_tweaks.md
@@ -1,13 +1,12 @@
 # Android Tweaks
-
-While OMNT should work without changes on the phone settings needed there are some options useful to set for better measurement results.
+While OMNT should work without changes on the phone settings needed, there are some options useful to set for better measurement results.
 
 ## Developer Settings
-The following settings can be found in the android developer settings menu. On Vanilla Android devices they are enabled by going to ```Settings -> About the phone``` and pressing there multiple times ```Build number```. If this is not working on your device a quick web search with your phone name and ```developer settings``` should help. After enabling the developer settings they are usually accessible via ```Settings -> System -> Developer Options```.
+The following settings can be found in the android developer settings menu. On Vanilla Android devices they are enabled by going to ```Settings -> About the phone``` and pressing there multiple times ```Build number```. If this is not working on your device, a quick web search with your phone name and ```developer settings``` should help. After enabling the developer settings they are usually accessible via ```Settings -> System -> Developer Options```.
 * USB debugging: Install and debug apps via ADB
 * Mobile data always active: Allows to gather mobile network information even if connected to WiFi
 * Force full GNSS measurements: might improve GNSS accuracy while logging
 
-Depending on your phone there might be more useful options (or less)
+Depending on your phone, there might be more useful options (or less)
 
 [Home](OpenMobileNetworkToolkit.md)
diff --git a/docs/carrier-permissions.md b/docs/carrier-permissions.md
@@ -1,5 +1,5 @@
 # SIM UICC configuration for Carrier Permissions
-Carrier specific settings can only be accessed by apps running with so-called carrier privileges. This was added in android 6 and is mostly relevant for 4G and 5G networks. (https://source.android.com/devices/tech/config/carrier). These permissions also allow OMNT to talk to APIs restricted to system apps (apps that are shipped with your phone usually not removable). OMNT works with out these permissions but some features will be disabled.
+Carrier specific settings can only be accessed by apps running with so-called carrier privileges. This was added in android 6 and is mostly relevant for 4G and 5G networks. (https://source.android.com/devices/tech/config/carrier). These permissions also allow OMNT to talk to APIs restricted to system apps (apps that are shipped with your phone usually not removable). OMNT works without these permissions, but some features will be disabled.
 
 Carrier or researcher who are able (admin key to the SIM card is required) to program their own sim cards can store a fingerprint of an signing certificate in an access rule applet (ARA-M) on the SIM card. 
 An app signed with this certificate will get carrier privileges granted by Android. (https://source.android.com/devices/tech/config/uicc)

diff --git a/docs/carrier_settings.md b/docs/carrier_settings.md
@@ -1,5 +1,4 @@
 # Carrier Settings View
-
-This view allows to read out and filter the current settings used by the phone for the currently used subscription. Those settings tell the phone how to behave in the specific network. This list of settings displayed here can be very long and differs from phone to phone. To alter the most relevant settings please see [Settings -> Mobile Network](settings/mobile_network.md).
+This view allows to read out and filter the current settings used by the phone for the currently used subscription. Those settings tell the phone how to behave in the specific network. This list of settings displayed here can be very long and differs from phone to phone. To alter the most relevant settings, please see [Settings -> Mobile Network](settings/mobile_network.md).
 
 [Home](OpenMobileNetworkToolkit.md)
diff --git a/docs/home.md b/docs/home.md
@@ -1,5 +1,4 @@
 # Home Screen 
-
 When starting the OMNT or touching the OMNT logo in the top left corner the home screen is displayed.
 Here are all information the OMNT can collect displayed. Different cards grouped the data into categories.
 The data displayed is updates on load and swipe down. This way the data of the time of refresh can be analyzed.
@@ -9,14 +8,13 @@ The same grouping is applied to the data send to the InfluxDB.
 This card displays information from the Android [CellInfo API](https://developer.android.com/reference/android/telephony/CellInfo). The cell information are on the cell the phone is camping on or registered to. If neighbor cells are present / announced and display of neighbor cells is enabled in the settings they are displayed to. Information  on neighbor cells are usually limited.
 
 ## Signal Strength Information
-This card displays information from the Android [Signal Strength API](https://developer.android.com/reference/android/telephony/SignalStrength). Signal information have less properties then the Cell info API but on some devices they seem to be more accurate / more often updated. 
+This card displays information from the Android [Signal Strength API](https://developer.android.com/reference/android/telephony/SignalStrength). Signal information have less properties than the Cell info API but on some devices they seem to be more accurate / more often updated. 
 
 ## Network Information
 This card presents the current network state of the phone. This includes the current mobile network registration as well as the default route, currently used access network and DNS.
 
-
 ## Device Information
-This card displays information on the phone it self. This information only change on e.g. firmware updates. It is often helpful to e.g. compare base band versions between to phones to spot the cause for different behavior.
+This card displays information on the phone itself. This information only changes on e.g. firmware updates. It is often helpful to e.g. compare baseband versions between to phones to spot the cause for different behavior.
 
 ## Device Features
 This card displays the availability of some relevant APIs on the phone.

diff --git a/docs/influxdb.md b/docs/influxdb.md
@@ -1,6 +1,6 @@
 # InfluxDB View
 
-This view allows the configuration of a locally (on the phone) running InfluxDB instance. This is currently still under development and should no be considered stable.
+This view allows the configuration of a locally (on the phone) running InfluxDB instance. This is currently still under development and should not be considered stable.
 
 Configuration of logging and remote InfluxDB hosts can be found in [Settings -> Logging](settings/logging.md)
 

diff --git a/docs/ping.md b/docs/ping.md
@@ -1,5 +1,5 @@
 # Ping, ICMP View
-[ICMP](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol) allows a high level analysis of the current network conditions. The input field allows to enter the target IP address as well as options of the ICMP command. If logging is enabled the results of the ICMP test are pushed to the InfluxDB and can be viewed in the dashboards. The most relevant KPIs gathered here are:
+[ICMP](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol) allows a high level analysis of the current network conditions. The input field allows entering the target IP address as well as options of the ICMP command. If logging is enabled, the results of the ICMP test are pushed to the InfluxDB and can be viewed in the dashboards. The most relevant KPIs gathered here are:
 * packet loss
 * RTT round trip time
 * jitter

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -71,6 +71,6 @@ Here we configure what data should be written to the database. Note that this al
 
 If everything is set up you can now scroll up to the top of the logging settings and enable the logging system. If your phone has a internet connection the logging logo will tun green when data is successfully transmitted to the database.
 
-You should now see the device and measurement selectable in the dashboards and graphs ans maps filling with data points.
+You should now see the device and measurement selectable in the dashboards and graphs and maps filling with data points.
 
 [Home](OpenMobileNetworkToolkit.md)
diff --git a/docs/settings/logging.md b/docs/settings/logging.md
@@ -7,7 +7,7 @@
 * Enable Notification Update: Show current cell information in the notification area of android. This will wake up the screen and my raise power consumption.
 
 ## Local Logging
-* InfluxDB log: This is work in progress and should allow the usage of a on device database
+* InfluxDB log: This is work in progress and should allow the usage of an on-device database
 * Log file: Measurements a written to a file on the phones internal memory.
 
 ## Remote Logging

diff --git a/docs/settings/mobile_network.md b/docs/settings/mobile_network.md
@@ -8,13 +8,13 @@ Note that not all devices will silently ignore some of the settings.
 * Persist until reboot: Make sure the setting will be applied after e.g. a SIM change until the next reboot
 
 ## Carrier Settings
-While there are a lot more carrier settings part of a phone configuration not all relevant or even accessible. This section allows to configure the profile 
+While there are a lot more carrier settings part of a phone configuration, not all relevant or even accessible. This section allows to configure the profile 
 applied for the selected subscription. OMNT will try to restore them after each network change event which mostly happens on SIM change, modem reboot and similar.
 This section reflects the settings desired to be applied and not necessary the current state. To look at the current state please use the [Carrier Settings](../carrier_settings.md) View from the menu.
 
 * Apply carrier settings now: This button will request the phone to apply the settings configured below to be applied.
 
-The different settings are grouped by the android API level on which they where introduced and will be disabled if the phones runs an older version.
+The different settings are grouped by the android API level on which they were introduced and will be disabled if the phone runs an older version.
 Details on the different settings can be found [here](https://developer.android.com/reference/android/telephony/CarrierConfigManager)
 
 [Settings](settings.md) | [Home](../OpenMobileNetworkToolkit.md)
diff --git a/docs/settings/reboot_modem.md b/docs/settings/reboot_modem.md
@@ -2,9 +2,9 @@
 
 [Home](../OpenMobileNetworkToolkit.md)
 
-The ```reboot modem``` button, carrier permissions required, triggers a reboot of the modem / base band of the phone.
+The ```reboot modem``` button, carrier permissions required, triggers a reboot of the modem / baseband of the phone.
 This usually affects all subscriptions / SIM cards / mobile network connection.
 
-Usually this is faster then toggling airplane mode and might also be a more deep reboot.
+Usually this is faster than toggling airplane mode and might also be a deeper reboot.
 
 [Settings](settings.md) | [Home](../OpenMobileNetworkToolkit.md)
diff --git a/docs/settings/set_subscrption.md b/docs/settings/set_subscrption.md
@@ -1,7 +1,7 @@
 # Set Subscription
-OMNT needs to attach it self to a so called Telephony Manager. Each Telephony Manager instance is tied to an active subscription (SIM card).
+OMNT needs to attach itself to a so-called Telephony Manager. Each Telephony Manager instance is tied to an active subscription (SIM card).
 Device with support for multiple subscriptions e.g. eUICCs and UICCs allow the usage of multiple subscriptions at the same time. Default OMNT will try to use the
-first active one which is most of the time the subscription configured for calls in the Android settings. 
+first active one, which is most of the time the subscription configured for calls in the Android settings. 
 By setting a different subscription e.g. a SIM card with carrier permissions enabling hashes deployed can be selected while connecting with a second subscription to a
 mobile network. Some feature will be disabled / not work for subscription without the permissions.
 

diff --git a/docs/settings/settings.md b/docs/settings/settings.md
@@ -6,7 +6,7 @@ OMNT has a lot of settings which allow a customization of the app behavior and i
 
 ## APP Settings
 * [Logging](logging.md): Configuration of the logging system of OMNT
-* [Mobile Network](mobile_network.md): Configure Carrier Settings an Mobile Network related options
+* [Mobile Network](mobile_network.md): Configure Carrier Settings and Mobile Network related options
 * [Set Subscription](set_subscrption.md): Choose the subscription to use
 * [Reboot Modem](reboot_modem.md): Reboot the modem of the phone
 

diff --git a/docs/special_codes.md b/docs/special_codes.md
@@ -1,5 +1,4 @@
 # Special Codes View
-
-This view, if carrier permissions are granted, allows to send so called Secret or Special Codes via the dialer API. Those codes are mostly vendor specific or even device specific and either enable hidden features or open developer menus. If carrier permissions are not granted those codes can also be entered into the system dialer. Some vendors e.g. Samsung don't allow this in there custom dialer but its usually possible to install the google dialer from play store and make this the default dialer. 
+This view, if carrier permissions are granted, allows sending so-called Secret or Special Codes via the dialer API. Those codes are mostly vendor specific or even device specific and either enable hidden features or open developer menus. If carrier permissions are not granted, those codes can also be entered into the system dialer. Some vendors e.g. Samsung don't allow this in their custom dialer, but it's usually possible to install the Google dialer from play store and make this the default dialer. 
 
 [Home](OpenMobileNetworkToolkit.md)
diff --git a/docs/subscriptions.md b/docs/subscriptions.md
@@ -1,4 +1,4 @@
 # Subscriptions View
-Subscriptions are profiles provided bei UICCs and eUICCS "SIMCARDs / eSIMprofiles" to the phone / base band to connect to mobile networks. This View displays information on currently enable subscriptions.
+Subscriptions are profiles provided by UICCs and eUICCS "SIMCARDs / eSIMprofiles" to the phone / baseband to connect to mobile networks. This View displays information on currently enable subscriptions.
 
 [Home](OpenMobileNetworkToolkit.md)
diff --git a/docs/workprofile.md b/docs/workprofile.md
@@ -1,4 +1,4 @@
 # Workprofile View
-[Android Workprofile](https://support.google.com/work/android/answer/6191949?hl=en) allows to separate Apps into two different spaces. This view allows to create such an work profile on the phone. The reasons this is in OMNT is that a work profile is necessary on Android to use network slicing. But it might come handy for other use cases to.
+[Android Workprofile](https://support.google.com/work/android/answer/6191949?hl=en) allows to separate Apps into two different spaces. This view allows to create such a work profile on the phone. The reasons this is in OMNT is that a work profile is necessary on Android to use network slicing. But it might come handy for other use cases to.
 
 [Home](OpenMobileNetworkToolkit.md)