Skip to content

Commit

Permalink
v3 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gcobb321 committed Jan 8, 2024
1 parent 1df3d3a commit 471c743
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 41 deletions.
68 changes: 34 additions & 34 deletions docs/chapters/0.3-index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## iCloud3 User Guide Index {docsify-ignore-all}

------
### Getting Started {docsify-ignore}
### Getting Started

#### [Introducing iCloud3](chapters/0.1-introduction.md)

Expand All @@ -24,43 +24,43 @@


------
### iCloud3 Components {docsify-ignore}
### iCloud3 Components

#### [Tracking Results screen](chapters/1.1-tracking-results-screen.md) {docsify-ignore}
#### [Tracking Results screen](chapters/1.1-tracking-results-screen.md)

- [Overview of the Tracking Results screen](chapters/1.1-tracking-results-screen?id=overview-of-the-tracking-results-screen)
- [Creating the Tracking Results screen (Lovelace yaml Code)](chapters/1.1-tracking-results-screen?id=creating-the-tracking-results-screen-lovelace-yaml-code)

#### [Event Log](chapters/1.2-event-log.md) {docsify-ignore}
#### [Event Log](chapters/1.2-event-log.md)

- [Quick Link Icons](chapters/1.2-event-log?id=quick-link-icons) {docsify-ignore}
- [Actions](chapters/1.2-event-log?id=actions) {docsify-ignore}
- [Creating the Event Log screen]/chapters/1.2-event-log?id=creating-the-event-log-screen) {docsify-ignore}
- [Lovelace Resource for the Event Log](chapters/2.3-ios-app?id=assigning-the-ios-app-device) {docsify-ignore}
- [Using another custom card directory](chapters/1.2-event-log?id=using-another-custom-card-directory) {docsify-ignore}
- [Event Log During Startup](chapters/1.2-event-log?id=event-log-during-startup) {docsify-ignore}
- [Stage 1 - Initial Preparation](chapters/1.2-event-log?id=stage-1-initial-preparation) {docsify-ignore}
- [Stage 2 - Prepare Support Services](chapters/1.2-event-log?id=stage-2-prepare-support-services) {docsify-ignore}
- [Stage 3 - Prepare Configured Devices](chapters/1.2-event-log?id=stage-3-prepare-configured-devices) {docsify-ignore}
- [Stage 4 - Setup iCloud & iOS App Tracking Methods](chapters/1.2-event-log?id=stage-4-setup-icloud-amp-ios-app-tracking-methods) {docsify-ignore}
- [Stage 5 - Configure Tracked Devices](chapters/1.2-event-log?id=stage-5-configure-tracked-devices) {docsify-ignore}
- [Quick Link Icons](chapters/1.2-event-log?id=quick-link-icons)
- [Actions](chapters/1.2-event-log?id=actions)
- [Creating the Event Log screen]/chapters/1.2-event-log?id=creating-the-event-log-screen)
- [Lovelace Resource for the Event Log](chapters/2.3-ios-app?id=assigning-the-ios-app-device)
- [Using another custom card directory](chapters/1.2-event-log?id=using-another-custom-card-directory)
- [Event Log During Startup](chapters/1.2-event-log?id=event-log-during-startup)
- [Stage 1 - Initial Preparation](chapters/1.2-event-log?id=stage-1-initial-preparation)
- [Stage 2 - Prepare Support Services](chapters/1.2-event-log?id=stage-2-prepare-support-services)
- [Stage 3 - Prepare Configured Devices](chapters/1.2-event-log?id=stage-3-prepare-configured-devices)
- [Stage 4 - Setup iCloud & iOS App Tracking Methods](chapters/1.2-event-log?id=stage-4-setup-icloud-amp-ios-app-tracking-methods)
- [Stage 5 - Configure Tracked Devices](chapters/1.2-event-log?id=stage-5-configure-tracked-devices)

#### [Configure iCloud3 Settings](chapters/1.3-configure-settings.md)

- [Opening the Configure Settings screens](chapters/1.3-configure-settings?id=opening-the-configure-settings-screens)
- [Main Menu screens](chapters/1.3-configure-settings?id=main-menu-screens)
- [Typical Configure Settings screens]chapters/1.3-configure-settings?id=typical-configure-settings-screens)
- [Typical Configure Settings screens](chapters/1.3-configure-settings?id=typical-configure-settings-screens)
- [Update Tracked Device screen](chapters/1.3-configure-settings?id=update-tracked-device-screen)
- [Format Settings screen](chapters/1.3-configure-settings?id=format-settings-screen)


------
### Location Data Sources {docsify-ignore}
### Location Data Sources

#### [iCloud Account Family Sharing Devices](chapters/2.1-icloud-account.md)

- [iCloud Account Family Sharing Devices (FamShr)]chapters/2.1-icloud-account?id=icloud-account-family-sharing-devices-famshr)
- [Configuring the iCloud Account as a Data Source]chapters/2.1-icloud-account?id=configuring-the-icloud-account-as-a-data-source)
- [iCloud Account Family Sharing Devices (FamShr)](chapters/2.1-icloud-account?id=icloud-account-family-sharing-devices-famshr)
- [Configuring the iCloud Account as a Data Source](chapters/2.1-icloud-account?id=configuring-the-icloud-account-as-a-data-source)
- [Changing the iCloud Account](chapters/2.1-icloud-account?id=changing-the-icloud-account)
- [Assigning the Family Sharing Device](chapters/2.1-icloud-account?id=assigning-the-family-sharing-device)
- [Tracking an Apple Watch](chapters/2.1-icloud-account?id=tracking-an-apple-watch)
Expand All @@ -75,15 +75,15 @@
- [Entering the Apple ID Verification Code](chapters/2.2-apple-id-verification?id=entering-the-apple-id-verification-code)
- [Requesting a New Verification Code](chapters/2.2-apple-id-verification?id=requesting-a-new-verification-code)
- [Access tokens, password and security](chapters/2.2-apple-id-verification?id=access-tokens-password-and-security)
- [Login email Notification from Apple]chapters/2.3-ios-app?id=configuring-the-ios-app-as-a-data-source)
- [Login email Notification from Apple](chapters/2.3-ios-app?id=configuring-the-ios-app-as-a-data-source)
- [What can you do to minimize these emails from clogging up your inbox](chapters/2.2-apple-id-verification?id=what-can-you-do-to-minimize-these-emails-from-clogging-up-your-inbox)

#### [Mobile App Integration, iOS App Entities)](chapters/2.3-ios-app.md)

- [Configuring the iOS App as a Data Source]chapters/2.3-ios-app?id=configuring-the-ios-app-as-a-data-source)
- [Configuring the iOS App as a Data Source](chapters/2.3-ios-app?id=configuring-the-ios-app-as-a-data-source)
- [Enable HA iOS Companion App data usage](chapters/2.3-ios-app?id=enable-ha-ios-companion-app-data-usage)

- [Assigning the iOS App Device]chapters/2.3-ios-app?id=assigning-the-ios-app-device)
- [Assigning the iOS App Device](chapters/2.3-ios-app?id=assigning-the-ios-app-device)
- [If the iOS App is not Installed](chapters/2.3-ios-app?id=if-the-ios-app-is-not-installed)
- [Using the iOS App with the Apple Watch](chapters/2.3-ios-app?id=using-the-ios-app-with-the-apple-watch)
- [Event Log Family Share Information When iCloud3 Starts](chapters/2.3-ios-app?id=event-log-family-share-information-when-icloud3-starts)
Expand All @@ -93,25 +93,25 @@


------
### Installing iCloud3 {docsify-ignore}
### Installing iCloud3
#### [Migrating from v2 to v3](chapters/3.1-migrating-v2-to-v3.md)

- [Upgrading to iCloud3 v3]chapters/3.1-migrating-v2-to-v3?id=upgrading-to-icloud3-v3)
- [Upgrading to iCloud3 v3](chapters/3.1-migrating-v2-to-v3?id=upgrading-to-icloud3-v3)
- [Generally, you will do the following:](chapters/3.1-migrating-v2-to-v3?id=generally-you-will-do-the-following)
- [Step #1 - Install iCloud3 v3](chapters/3.2-installing-and-configuring?id=clearing-the-browser39s-cache)
- [Easy Way - Use HACS](chapters/3.1-migrating-v2-to-v3?id=easy-way-use-hacs)
- [Hard Way (but not too hard) - Manual Installation](chapters/3.1-migrating-v2-to-v3?id=hard-way-but-not-too-hard-manual-installation)
- [Step #2 - Add the iCloud3 Integration and Verify the Configuration](chapters/3.1-migrating-v2-to-v3?id=step-2-add-the-icloud3-integration-and-verify-the-configuration)
- [Step 3 - Review the Parameter Migration Results](chapters/3.2-installing-and-configuring?id=clearing-the-browser39s-cache)
- [Step #3.1 - The *iCloud Account & iOS App* screen]chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [Step #3.1 - The *iCloud Account & iOS App* screen](chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [Enable Family Sharing data usage](chapters/3.1-migrating-v2-to-v3?id=enable-family-sharing-data-usage)
- [Enable HA iOS Companion App data usage](chapters/3.1-migrating-v2-to-v3?id=enable-ha-ios-companion-app-data-usage)
- [iCloud Account Authentication](chapters/3.1-migrating-v2-to-v3?id=icloud-account-authentication)
- [Step #3.2 - The *iCloud3 Devices* screen](chapters/3.1-migrating-v2-to-v3?id=step-32-the-icloud3-devices-screen)
- [Step #3.3 - The *Update Tracked iCloud3 Device* screen](chapters/3.1-migrating-v2-to-v3?id=step-33-the-update-tracked-icloud3-device-screen)
- [Step #3.4 - The *Sensors* selection screen](chapters/3.1-migrating-v2-to-v3?id=step-34-the-sensors-selection-screen)
- [Step #4 - Exit *The Configuration Wizard* and Restart iCloud3](chapters/3.1-migrating-v2-to-v3?id=step-4-exit-the-configuration-wizard-and-restart-icloud3)
- [Step #5 - Clear the Browsers Cache]chapters/3.2-installing-and-configuring?id=step-5-set-up-a-lovelace-card-tracking-card)
- [Step #5 - Clear the Browsers Cache](chapters/3.2-installing-and-configuring?id=step-5-set-up-a-lovelace-card-tracking-card)
- - [Clear the Browser's Cache (Chrome, Edge, Safari, MacOS)](chapters/3.1-migrating-v2-to-v3?id=clear-the-browser39s-cache-chrome-edge-safari-macos)
- [Clear the Home Assistant Companion (iOS App) Cache](chapters/3.1-migrating-v2-to-v3?id=clear-the-home-assistant-companion-ios-app-cache)
- [Step #6 - Restart Home Assistant (if necessary)](chapters/3.1-migrating-v2-to-v3?id=step-6-restart-home-assistant-if-necessary)
Expand All @@ -122,28 +122,28 @@

- [Step #1 - Install iCloud3](chapters/3.2-installing-and-configuring?id=step-1-install-icloud3)
- [Step #2 - Install the iOS App on your iPhone or iPad](chapters/3.2-installing-and-configuring?id=step-2-install-the-ios-app-on-your-iphone-or-ipad)
- [Step #3 - Add the iCloud3 Integration and open *Configure Settings*]chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [Step #3 - Add the iCloud3 Integration and open *Configure Settings*](chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [Step #3.1 - iCloud Account & iOS App screen](chapters/3.2-installing-and-configuring?id=step-31-icloud-account-amp-ios-app-screen)
- [Step #3.2 - iCloud3 Devices screen](chapters/3.2-installing-and-configuring?id=step-32-icloud3-devices-screen)
- [Step #3.3 - Add Tracked iCloud3 Device screen](chapters/3.2-installing-and-configuring?id=step-33-add-tracked-icloud3-device-screen)
- [Step #3.4 - Update Tracked iCloud3 Device screen](chapters/3.2-installing-and-configuring?id=step-34-update-tracked-icloud3-device-screen)
- [Step #4 - Exit the *Configure Settings* screens and Restart iCloud3]chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [Step #4 - Exit the *Configure Settings* screens and Restart iCloud3](chapters/3.2-installing-and-configuring?id=step-3-add-the-icloud3-integration-and-open-configure-settings)
- [The Other Configuration Screens](chapters/3.2-installing-and-configuring?id=the-other-configuration-screens)
- [Step #5 - Set up a Lovelace card tracking card]chapters/3.2-installing-and-configuring?id=step-5-set-up-a-lovelace-card-tracking-card)
- [Step #5 - Set up a Lovelace card tracking card](chapters/3.2-installing-and-configuring?id=step-5-set-up-a-lovelace-card-tracking-card)
- [Step 5.1 - Create the Lovelace iCloud3 Dashboard](chapters/3.2-installing-and-configuring?id=step-51-create-the-lovelace-icloud3-dashboard)
- [Step 5.2 - Create the device tracking portion of the lovelace screen](chapters/3.2-installing-and-configuring?id=step-52-create-the-device-tracking-portion-of-the-lovelace-screen)
- [Step 5.3 - Create the Event Log portion of the Lovelace screen](chapters/3.2-installing-and-configuring?id=step-53-create-the-event-log-portion-of-the-lovelace-screen)
- [Step 5.4 - Set up the *icloud3-event-log-card* Lovelace Resource (if needed)](chapters/3.2-installing-and-configuring?id=step-54-set-up-the-icloud3-event-log-card-lovelace-resource-if-needed)
- [Congratulations, iCloud3 is set up](chapters/3.2-installing-and-configuring?id=congratulations-icloud3-is-set-up)
- [Installation Notes](chapters/3.2-installing-and-configuring?id=installation-notes)
- [Restart Home Assistant (if necessary)](chapters/3.2-installing-and-configuring?id=restart-home-assistant-if-necessary)
- [Clearing the Browser's Cache]chapters/3.2-installing-and-configuring?id=clearing-the-browser39s-cache)
- [Clearing the Browser's Cache](chapters/3.2-installing-and-configuring?id=clearing-the-browser39s-cache)
- [Clear the Browser's Cache (Chrome, Edge, Safari, MacOS)](chapters/3.2-installing-and-configuring?id=clear-the-browser39s-cache-chrome-edge-safari-macos)
- [Clear the Home Assistant Companion (iOS App) Cache](chapters/3.2-installing-and-configuring?id=clear-the-home-assistant-companion-ios-app-cache)
- [iCloud3 Log File](chapters/3.2-installing-and-configuring?id=icloud3-log-file)

------
#### Reference {docsify-ignore}
#### Reference

#### [Configuration Screens & Parameters](chapters/7.1-config-parms.md)

Expand All @@ -163,7 +163,7 @@
- [Waze Route Distance & Time, Waze History Database](chapters/7.1-config-parms?id=waze-route-distance-amp-time-waze-history-database)
- [Waze Location Map Display](chapters/7.1-config-parms?id=waze-location-map-display)
- [inZone Intervals](chapters/7.1-config-parms?id=inzone-intervals)
- [Special Zones]chapters/7.1-config-parms?id=special-zones)
- [Special Zones](chapters/7.1-config-parms?id=special-zones)
- [Enter Zone Delay](chapters/7.1-config-parms?id=enter-zone-delay)
- [Stationary Zone](chapters/7.1-config-parms?id=stationary-zone)
- [Primary Base Zone](chapters/7.1-config-parms?id=primary-base-zone)
Expand All @@ -172,7 +172,7 @@
#### [Other iCloud3 Features](chapters/7.2-other-topics.md)

- [Tracking From More Than One Zone](chapters/7.2-other-topics?id=tracking-from-more-than-one-zone)
- [Display the Waze History Locations on a Map Card]chapters/7.2-other-topics?id=display-the-waze-history-locations-on-a-map-card)
- [Display the Waze History Locations on a Map Card](chapters/7.2-other-topics?id=display-the-waze-history-locations-on-a-map-card)
- [How to Remove the Lines Between the Locations](chapters/7.2-other-topics?id=how-to-remove-the-lines-between-the-locations)
- [Loading the saved locations](chapters/7.2-other-topics?id=loading-the-saved-locations)

Expand Down Expand Up @@ -239,7 +239,7 @@
- [The phone does not exit a zone:](chapters/8.2-frequently-asked-questions?id=the-phone-does-not-exit-a-zone)
- [App Specific Passwords](chapters/8.2-frequently-asked-questions?id=app-specific-passwords)

- [iCloud3 General Questions:]chapters/7.2-other-topics?id=display-the-waze-history-locations-on-a-map-card)
- [iCloud3 General Questions:](chapters/7.2-other-topics?id=display-the-waze-history-locations-on-a-map-card)
- [What Version of iCloud3 is Running](chapters/8.2-frequently-asked-questions?id=what-version-of-icloud3-is-running)

#### [ Troubleshooting Problems](chapters/8.3-troubleshooting-problems.md)
Expand Down
12 changes: 5 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@
</head>
<body>
<div id="app"></div>
<!--<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>-->
<!--
<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
<script src="./docsify-edit-on-github.js"></script>
-->


<script src="./docsify-edit-on-github.js"></script>

<!--
toc: {
scope: '.markdown-section',
Expand Down Expand Up @@ -48,11 +51,6 @@
crossChapterText: false,
},

toc: {
scope: '.markdown-section',
headings: 'h2, h3, h4, h5, h6',
},


plugins: [
EditOnGithubPlugin.create(
Expand Down

0 comments on commit 471c743

Please sign in to comment.