diff --git a/site/03-todo.md b/site/03-todo.md index 18ac655..a6e22dc 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -1,7 +1,7 @@ # ToDo - LAN Setup - Android - Screenshots of LAN setup and verify steps on an Android 12+ device - Update all guides in service repos - - Service-specific Guides + - Service-specific Guides (link to wrapper repos) - Verify LAN setup steps on a Mac - Verify Tor setup steps on a Mac - Add / verify ALL links in the **UI** go to the right place in docs @@ -12,7 +12,7 @@ - Initial Setup - DIY Guide - Possible sounds in troubleshooting (and walkthrough?) -- Migrations +- Migration / Recovery - Backups - CIFS - OS guides for CIFS (screens) @@ -26,3 +26,4 @@ # AFTER PUBLISHING: - Create badges for device guide topic boxes - There are many issues that should be closed by 0.3 docs release (some issues await new processes in order to test) +- Email signup diff --git a/site/source/about/roadmap.rst b/site/source/about/roadmap.rst index 6393de5..ede2531 100644 --- a/site/source/about/roadmap.rst +++ b/site/source/about/roadmap.rst @@ -4,10 +4,11 @@ Roadmap ======= -Probably needs to actually be an html page that is linked to from "About" +Under Construction +------------------ +Please pardon our dust... -Also badly needs updating .. .. raw:: html diff --git a/site/source/support/dev-docs/dev-faq/faq-contributing.rst b/site/source/support/dev-docs/dev-faq/faq-contributing.rst index 3968ad0..ab7647c 100644 --- a/site/source/support/dev-docs/dev-faq/faq-contributing.rst +++ b/site/source/support/dev-docs/dev-faq/faq-contributing.rst @@ -1,8 +1,8 @@ .. _faq-contributing: -============ -Contributing -============ +================ +Contributing FAQ +================ We ❤️ contributions! diff --git a/site/source/support/dev-docs/dev-faq/faq-service-packaging.rst b/site/source/support/dev-docs/dev-faq/faq-service-packaging.rst index a68a224..7d7e749 100644 --- a/site/source/support/dev-docs/dev-faq/faq-service-packaging.rst +++ b/site/source/support/dev-docs/dev-faq/faq-service-packaging.rst @@ -4,9 +4,9 @@ :depth: 3 :local: -===================== -Service Packaging FAQ -===================== +============= +Packaging FAQ +============= Do I need programming experience to package a service for EmbassyOS? -------------------------------------------------------------------- diff --git a/site/source/support/dev-docs/dev-tools/service-container.rst b/site/source/support/dev-docs/dev-tools/service-container.rst index 73ac692..09d3b26 100644 --- a/site/source/support/dev-docs/dev-tools/service-container.rst +++ b/site/source/support/dev-docs/dev-tools/service-container.rst @@ -1,8 +1,8 @@ .. _exec-service-container: -========================= -Enter a Service Container -========================= +================== +Service Containers +================== For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's :ref:`container` in order to directly interface with it and issue commands. diff --git a/site/source/support/dev-docs/service-packaging/index.rst b/site/source/support/dev-docs/service-packaging/index.rst index 80ec948..4450628 100644 --- a/site/source/support/dev-docs/service-packaging/index.rst +++ b/site/source/support/dev-docs/service-packaging/index.rst @@ -1,8 +1,8 @@ .. _service-packaging-spec: -=============================== -Service Packaging Specification -=============================== +====================== +Service Packaging Spec +====================== Welcome! If you are here, you are interested in becoming part of the mission to change the future of personal computing. This guide will take you through the process of packaging a service for EmbassyOS, a novel, self-hosted, sovereign computing platform. diff --git a/site/source/support/dev-docs/service-packaging/overview.rst b/site/source/support/dev-docs/service-packaging/overview.rst index a7d1f3c..6f354db 100644 --- a/site/source/support/dev-docs/service-packaging/overview.rst +++ b/site/source/support/dev-docs/service-packaging/overview.rst @@ -1,8 +1,8 @@ .. _service_package_overview: -======================== -Service Package Overview -======================== +================== +Packaging Overview +================== .. contents:: :depth: 2 diff --git a/site/source/support/faq/index.rst b/site/source/support/faq/index.rst index e792851..7ebe641 100644 --- a/site/source/support/faq/index.rst +++ b/site/source/support/faq/index.rst @@ -11,8 +11,8 @@ Answers to Frequently Asked Questions from Embassy users faq-general faq-030 - faq-basic-use faq-troubleshooting + faq-basic-use faq-embassy faq-services faq-bitcoin diff --git a/site/source/support/user-manual/configuration/lan-setup/index.rst b/site/source/support/user-manual/configuration/lan-setup/index.rst index ae48482..9060c9e 100644 --- a/site/source/support/user-manual/configuration/lan-setup/index.rst +++ b/site/source/support/user-manual/configuration/lan-setup/index.rst @@ -1,8 +1,8 @@ .. _lan-setup: -============ -Local Access -============ +================= +Local (LAN) Setup +================= When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices` before setting up a :ref:`Browser`. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst index d6275c1..f40c5a7 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst @@ -1,8 +1,8 @@ .. _lan-browser: -==================== -LAN Setup - Browsers -==================== +============= +LAN - Browser +============= When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst index 6fefdbb..647d933 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst @@ -1,8 +1,8 @@ .. _lan-os: -=================== -LAN Setup - Devices -=================== +============ +LAN - Device +============ When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. diff --git a/site/source/support/user-manual/configuration/limitations/lim-android.rst b/site/source/support/user-manual/configuration/limitations/lim-android.rst index 2b9aeb4..1e1267a 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-android.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-android.rst @@ -1,8 +1,8 @@ .. _lim-android: -========================= -Android Known Limitations -========================= +======= +Android +======= Local Access ------------ diff --git a/site/source/support/user-manual/configuration/limitations/lim-ios.rst b/site/source/support/user-manual/configuration/limitations/lim-ios.rst index fe923c9..68620a7 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-ios.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-ios.rst @@ -1,8 +1,8 @@ .. _lim-ios: -===================== -iOS Known Limitations -===================== +=== +iOS +=== Tor --- diff --git a/site/source/support/user-manual/configuration/limitations/lim-linux.rst b/site/source/support/user-manual/configuration/limitations/lim-linux.rst index 8bb1122..0753b80 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-linux.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-linux.rst @@ -1,7 +1,7 @@ .. _lim-linux: -======================= -Linux Known Limitations -======================= +===== +Linux +===== Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race... diff --git a/site/source/support/user-manual/configuration/limitations/lim-mac.rst b/site/source/support/user-manual/configuration/limitations/lim-mac.rst index 0b1f543..8294450 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-mac.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-mac.rst @@ -1,7 +1,7 @@ .. _lim-mac: -===================== -Mac Known Limitations -===================== +=== +Mac +=== MacOS has no known limitations in regard to Embassy at this time. diff --git a/site/source/support/user-manual/configuration/limitations/lim-windows.rst b/site/source/support/user-manual/configuration/limitations/lim-windows.rst index d83588a..27fe631 100644 --- a/site/source/support/user-manual/configuration/limitations/lim-windows.rst +++ b/site/source/support/user-manual/configuration/limitations/lim-windows.rst @@ -1,8 +1,8 @@ .. _lim-windows: -========================= -Windows Known Limitations -========================= +======= +Windows +======= Windows10 has no known limitations in regard to Embassy at this time. diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst b/site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst index b981ea1..e976b24 100644 --- a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst +++ b/site/source/support/user-manual/configuration/tor-setup/tor-firefox/index.rst @@ -1,8 +1,8 @@ .. _tor-firefox: -=================== -Tor Setup - Firefox -=================== +============= +Tor - Firefox +============= .. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer`. diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst b/site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst index 23e43d7..9f8758d 100644 --- a/site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst +++ b/site/source/support/user-manual/configuration/tor-setup/tor-os/index.rst @@ -1,8 +1,8 @@ .. _tor-os: -=================== -Tor Setup - Devices -=================== +============ +Tor - Device +============ Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Embassy with remotely. diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-android.rst b/site/source/support/user-manual/getting-started/device-guides/dg-android.rst index bccb60c..233cf3a 100644 --- a/site/source/support/user-manual/getting-started/device-guides/dg-android.rst +++ b/site/source/support/user-manual/getting-started/device-guides/dg-android.rst @@ -1,8 +1,8 @@ .. _dg-android: -============== -Android Guides -============== +======= +Android +======= .. tip:: Please see Android's :ref:`Known Limitations` to understand what is currently not possible on these devices diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst b/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst index f645be6..91053c1 100644 --- a/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst +++ b/site/source/support/user-manual/getting-started/device-guides/dg-ios.rst @@ -1,8 +1,8 @@ .. _dg-ios: -========== -iOS Guides -========== +=== +iOS +=== .. tip:: Please see iOS's :ref:`Known Limitations` to understand what is currently not possible on these devices diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst b/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst index 15f9310..5f89d68 100644 --- a/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst +++ b/site/source/support/user-manual/getting-started/device-guides/dg-linux.rst @@ -1,8 +1,8 @@ .. _dg-linux: -============ -Linux Guides -============ +===== +Linux +===== .. tip:: Please see Linux's :ref:`Known Limitations` to understand what is currently not possible on these devices diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst b/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst index 6962181..ce53647 100644 --- a/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst +++ b/site/source/support/user-manual/getting-started/device-guides/dg-mac.rst @@ -1,8 +1,8 @@ .. _dg-mac: -========== -Mac Guides -========== +=== +Mac +=== .. tip:: Please see Mac's :ref:`Known Limitations` to understand what is currently not possible on these devices @@ -32,4 +32,4 @@ Mac Guides :link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-mac :anchor: Backup - Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster. \ No newline at end of file + Configure remote backups of your Embassy to your Windows machine. **Backups are supremely important** as they ensure redundancy of your data for convenience, as well as preventing loss in case of disaster. diff --git a/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst b/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst index a3eba24..bd8e9a4 100644 --- a/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst +++ b/site/source/support/user-manual/getting-started/device-guides/dg-windows.rst @@ -1,8 +1,8 @@ .. _dg-windows: -============== -Windows Guides -============== +======= +Windows +======= .. tip:: Please see Window's :ref:`Known Limitations` to understand what is currently not possible on these devices. diff --git a/site/source/support/user-manual/getting-started/device-guides/index.rst b/site/source/support/user-manual/getting-started/device-guides/index.rst index 0b59e74..03bd5cb 100644 --- a/site/source/support/user-manual/getting-started/device-guides/index.rst +++ b/site/source/support/user-manual/getting-started/device-guides/index.rst @@ -1,8 +1,8 @@ .. _device-guides: -====================== -Device-Specific Guides -====================== +============= +Device Guides +============= Guides to get connected with or improve your Embassy by device-type. diff --git a/site/source/support/user-manual/getting-started/recover-02.rst b/site/source/support/user-manual/getting-started/recover-02.rst index cf65ecc..a1b0015 100644 --- a/site/source/support/user-manual/getting-started/recover-02.rst +++ b/site/source/support/user-manual/getting-started/recover-02.rst @@ -1,8 +1,8 @@ .. _recover-02x: -=================================== -Migrate Embassy from Versions 0.2.x -=================================== +=================== +Migrate v0.2.x Data +=================== .. contents:: :depth: 4 diff --git a/site/source/support/user-manual/getting-started/recover-03.rst b/site/source/support/user-manual/getting-started/recover-03.rst index 69354d8..0486019 100644 --- a/site/source/support/user-manual/getting-started/recover-03.rst +++ b/site/source/support/user-manual/getting-started/recover-03.rst @@ -1,8 +1,8 @@ .. _recover-03x: -=================================== -Recover Embassy from Versions 0.3.x -=================================== +=================== +Recover v0.3.x Data +=================== Recover Embassy Series 0.3.x Data --------------------------------- diff --git a/site/source/support/user-manual/services/managing-services/service-overview.rst b/site/source/support/user-manual/services/managing-services/service-overview.rst index a6a1ce2..f1dfebe 100644 --- a/site/source/support/user-manual/services/managing-services/service-overview.rst +++ b/site/source/support/user-manual/services/managing-services/service-overview.rst @@ -1,8 +1,8 @@ .. _service-overview: -================= -Services Overview -================= +======== +Overview +======== Services are very similar to Applications on a mobile device. The biggest differences are that they are often designed to run constantly, with 24/7 availability for when a user requires them. This is why they are called :ref:`Services`, they are always ready to serve users! diff --git a/site/source/support/user-manual/troubleshooting/shoot-connection.rst b/site/source/support/user-manual/troubleshooting/shoot-connection.rst index 89e26d8..0711cb5 100644 --- a/site/source/support/user-manual/troubleshooting/shoot-connection.rst +++ b/site/source/support/user-manual/troubleshooting/shoot-connection.rst @@ -1,8 +1,8 @@ .. _shoot-connection: -=========================== -Troubleshooting Connections -=========================== +=========== +Connections +=========== During initial setup, I am unable to connect to ``embassy.local``. ------------------------------------------------------------------ @@ -16,4 +16,4 @@ Make sure you have successfully followed the :ref:`LAN Setup` instruc I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address -------------------------------------------------------------------------------- -First, attmept to connect using :ref:`The Tor Browser`. This is a good test because Tor Browser has Tor built in. If you cannot reach your ``.onion`` with Tor Browser, reboot the Embassy by unplugging power and plugging it back in. This will reset your Tor connection. If you can reach via Tor Browser, but not with another browser, then follow the setup guides to run Tor on your device :ref:`Natively` and/or to :ref:`Configure Your Browser`. \ No newline at end of file +First, attmept to connect using :ref:`The Tor Browser`. This is a good test because Tor Browser has Tor built in. If you cannot reach your ``.onion`` with Tor Browser, reboot the Embassy by unplugging power and plugging it back in. This will reset your Tor connection. If you can reach via Tor Browser, but not with another browser, then follow the setup guides to run Tor on your device :ref:`Natively` and/or to :ref:`Configure Your Browser`. diff --git a/site/source/support/user-manual/troubleshooting/shoot-embassy.rst b/site/source/support/user-manual/troubleshooting/shoot-embassy.rst index 2dd0243..d42b613 100644 --- a/site/source/support/user-manual/troubleshooting/shoot-embassy.rst +++ b/site/source/support/user-manual/troubleshooting/shoot-embassy.rst @@ -1,8 +1,8 @@ .. _shoot-embassy: -======================= -Troubleshooting Embassy -======================= +======= +Embassy +======= Hardware -------- diff --git a/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst b/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst index 9e5a3a2..1ca47f0 100644 --- a/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst +++ b/site/source/support/user-manual/tuning/advanced-config/alt-marketplace.rst @@ -1,8 +1,8 @@ .. _alt-marketplace: -======================= -Alternative Marketplace -======================= +=============== +Alt Marketplace +=============== EmbassyOS supports accessing alternative marketplaces. diff --git a/site/source/support/user-manual/tuning/advanced-config/index.rst b/site/source/support/user-manual/tuning/advanced-config/index.rst index 799bedd..e16b6a8 100644 --- a/site/source/support/user-manual/tuning/advanced-config/index.rst +++ b/site/source/support/user-manual/tuning/advanced-config/index.rst @@ -1,8 +1,8 @@ .. _advanced-config: -====================== -Advanced Configuration -====================== +=============== +Advanced Config +=============== Custom options for folks that "know what they're doing." diff --git a/site/source/support/user-manual/tuning/service-guides/bitcoin.rst b/site/source/support/user-manual/tuning/service-guides/bitcoin.rst index 81bd55b..96eaf21 100644 --- a/site/source/support/user-manual/tuning/service-guides/bitcoin.rst +++ b/site/source/support/user-manual/tuning/service-guides/bitcoin.rst @@ -32,26 +32,42 @@ You can also drop into a shell using:: and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``. +Software Wallets +---------------- + .. _electrum: Electrum --------- +======== + +Available for +............. +-Linux **UNTESTED** .. _fully-noded: FullyNoded ----------- +========== -.. note:: Mac only +.. note:: Mac / iOS only + +**UNTESTED** + +.. _ledger-live: + +Ledger Live +=========== + +.. tip:: Built for use with Ledger hardware devices **UNTESTED** .. _samourai: Samourai --------- +======== .. note:: Android only @@ -60,33 +76,25 @@ Samourai .. _sparrow: Sparrow -------- +======= **UNTESTED** .. _specter: Specter -------- +======= Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter **UNTESTED** -.. _trezor: +.. _trezor-suite: Trezor Suite ------------- +============ .. tip:: Built for use with Trezor hardware devices **UNTESTED** -.. _ledger: - -Ledger Live ------------ - -.. tip:: Built for use with Ledger hardware devices - -**UNTESTED** diff --git a/site/source/support/user-manual/tuning/service-guides/index.rst b/site/source/support/user-manual/tuning/service-guides/index.rst index 7feea78..52891b0 100644 --- a/site/source/support/user-manual/tuning/service-guides/index.rst +++ b/site/source/support/user-manual/tuning/service-guides/index.rst @@ -1,8 +1,8 @@ .. _service-guides: -======================= -Service-Specific Guides -======================= +============== +Service Guides +============== These guides will help you to setup external tools to connect or interact with specific :ref:`Services`, such as a chat client or :ref:`Bitcoin` wallet. diff --git a/site/source/support/user-manual/tuning/tune-embassy-os.rst b/site/source/support/user-manual/tuning/tune-embassy-os.rst index a852444..19773b4 100644 --- a/site/source/support/user-manual/tuning/tune-embassy-os.rst +++ b/site/source/support/user-manual/tuning/tune-embassy-os.rst @@ -1,8 +1,8 @@ .. _tune-embassy-os: -===================== -Customizing EmbassyOS -===================== +=============== +Customizing EOS +=============== .. _device-name: diff --git a/site/source/support/user-manual/walkthrough/error-logs.rst b/site/source/support/user-manual/walkthrough/error-logs.rst index 4eae224..c6ba860 100644 --- a/site/source/support/user-manual/walkthrough/error-logs.rst +++ b/site/source/support/user-manual/walkthrough/error-logs.rst @@ -1,8 +1,8 @@ .. _error-logs: -============================= -Anonymous Error Log Reporting -============================= +=================== +Error Log Reporting +=================== When you fire up your Embassy for the first time, you will be greeted with a modal asking you if you would be willing to provide your error logs to Start9 to assist us in improving EmbassyOS and its ecosystem. The decision to send or retain this data is 100% yours. Below are details to aid you in determining your choice. diff --git a/site/source/support/user-manual/walkthrough/overview.rst b/site/source/support/user-manual/walkthrough/overview.rst index c035f1a..deb8008 100644 --- a/site/source/support/user-manual/walkthrough/overview.rst +++ b/site/source/support/user-manual/walkthrough/overview.rst @@ -1,8 +1,8 @@ .. _overview: -===================== -Overview of EmbassyOS -===================== +================== +EmbassyOS Overview +================== .. _services-tab: