Lots of menu edits for readability

This commit is contained in:
kn0wmad
2022-01-29 04:09:45 -07:00
committed by Lucy Cifferello
parent 5be68f6a40
commit f753b2c429
36 changed files with 129 additions and 119 deletions

View File

@@ -1,7 +1,7 @@
# ToDo # ToDo
- LAN Setup - Android - Screenshots of LAN setup and verify steps on an Android 12+ device - LAN Setup - Android - Screenshots of LAN setup and verify steps on an Android 12+ device
- Update all guides in service repos - Update all guides in service repos
- Service-specific Guides - Service-specific Guides (link to wrapper repos)
- Verify LAN setup steps on a Mac - Verify LAN setup steps on a Mac
- Verify Tor 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 - Add / verify ALL links in the **UI** go to the right place in docs
@@ -12,7 +12,7 @@
- Initial Setup - Initial Setup
- DIY Guide - DIY Guide
- Possible sounds in troubleshooting (and walkthrough?) - Possible sounds in troubleshooting (and walkthrough?)
- Migrations - Migration / Recovery
- Backups - Backups
- CIFS - CIFS
- OS guides for CIFS (screens) - OS guides for CIFS (screens)
@@ -26,3 +26,4 @@
# AFTER PUBLISHING: # AFTER PUBLISHING:
- Create badges for device guide topic boxes <connectivity, performance, resilience and/or tuning> - Create badges for device guide topic boxes <connectivity, performance, resilience and/or tuning>
- There are many issues that should be closed by 0.3 docs release (some issues await new processes in order to test) - There are many issues that should be closed by 0.3 docs release (some issues await new processes in order to test)
- Email signup

View File

@@ -4,10 +4,11 @@
Roadmap 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 .. .. raw:: html

View File

@@ -1,8 +1,8 @@
.. _faq-contributing: .. _faq-contributing:
============ ================
Contributing Contributing FAQ
============ ================
We ❤️ contributions! We ❤️ contributions!

View File

@@ -4,9 +4,9 @@
:depth: 3 :depth: 3
:local: :local:
===================== =============
Service Packaging FAQ Packaging FAQ
===================== =============
Do I need programming experience to package a service for EmbassyOS? Do I need programming experience to package a service for EmbassyOS?
-------------------------------------------------------------------- --------------------------------------------------------------------

View File

@@ -1,8 +1,8 @@
.. _exec-service-container: .. _exec-service-container:
========================= ==================
Enter a Service Container Service Containers
========================= ==================
For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI<web-ui>`, 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<containers>` in order to directly interface with it and issue commands. For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI<web-ui>`, 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<containers>` in order to directly interface with it and issue commands.

View File

@@ -1,8 +1,8 @@
.. _service-packaging-spec: .. _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. 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.

View File

@@ -1,8 +1,8 @@
.. _service_package_overview: .. _service_package_overview:
======================== ==================
Service Package Overview Packaging Overview
======================== ==================
.. contents:: .. contents::
:depth: 2 :depth: 2

View File

@@ -11,8 +11,8 @@ Answers to Frequently Asked Questions from Embassy users
faq-general faq-general
faq-030 faq-030
faq-basic-use
faq-troubleshooting faq-troubleshooting
faq-basic-use
faq-embassy faq-embassy
faq-services faq-services
faq-bitcoin faq-bitcoin

View File

@@ -1,8 +1,8 @@
.. _lan-setup: .. _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<lan>` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices<lan-os>` before setting up a :ref:`Browser<lan-browser>`. When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access<lan>` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices<lan-os>` before setting up a :ref:`Browser<lan-browser>`.

View File

@@ -1,8 +1,8 @@
.. _lan-browser: .. _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<lan>` is much faster and will allow access to your data, even with no Internet connection. When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access<lan>` is much faster and will allow access to your data, even with no Internet connection.

View File

@@ -1,8 +1,8 @@
.. _lan-os: .. _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<lan>` is much faster and will allow access to your data, even with no Internet connection. When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access<lan>` is much faster and will allow access to your data, even with no Internet connection.

View File

@@ -1,8 +1,8 @@
.. _lim-android: .. _lim-android:
========================= =======
Android Known Limitations Android
========================= =======
Local Access Local Access
------------ ------------

View File

@@ -1,8 +1,8 @@
.. _lim-ios: .. _lim-ios:
===================== ===
iOS Known Limitations iOS
===================== ===
Tor Tor
--- ---

View File

@@ -1,7 +1,7 @@
.. _lim-linux: .. _lim-linux:
======================= =====
Linux Known Limitations Linux
======================= =====
Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race... Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race...

View File

@@ -1,7 +1,7 @@
.. _lim-mac: .. _lim-mac:
===================== ===
Mac Known Limitations Mac
===================== ===
MacOS has no known limitations in regard to Embassy at this time. MacOS has no known limitations in regard to Embassy at this time.

View File

@@ -1,8 +1,8 @@
.. _lim-windows: .. _lim-windows:
========================= =======
Windows Known Limitations Windows
========================= =======
Windows10 has no known limitations in regard to Embassy at this time. Windows10 has no known limitations in regard to Embassy at this time.

View File

@@ -1,8 +1,8 @@
.. _tor-firefox: .. _tor-firefox:
=================== =============
Tor Setup - Firefox Tor - Firefox
=================== =============
.. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer<running-tor>`. .. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer<running-tor>`.

View File

@@ -1,8 +1,8 @@
.. _tor-os: .. _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. 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.

View File

@@ -1,8 +1,8 @@
.. _dg-android: .. _dg-android:
============== =======
Android Guides Android
============== =======
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices .. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-ios: .. _dg-ios:
========== ===
iOS Guides iOS
========== ===
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices .. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-linux: .. _dg-linux:
============ =====
Linux Guides Linux
============ =====
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices .. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-mac: .. _dg-mac:
========== ===
Mac Guides Mac
========== ===
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices .. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` 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 :link: https://start9.com/latest/support/user-manual/walkthrough/backup/backup-mac
:anchor: Backup :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. 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.

View File

@@ -1,8 +1,8 @@
.. _dg-windows: .. _dg-windows:
============== =======
Windows Guides Windows
============== =======
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices. .. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.

View File

@@ -1,8 +1,8 @@
.. _device-guides: .. _device-guides:
====================== =============
Device-Specific Guides Device Guides
====================== =============
Guides to get connected with or improve your Embassy by device-type. Guides to get connected with or improve your Embassy by device-type.

View File

@@ -1,8 +1,8 @@
.. _recover-02x: .. _recover-02x:
=================================== ===================
Migrate Embassy from Versions 0.2.x Migrate v0.2.x Data
=================================== ===================
.. contents:: .. contents::
:depth: 4 :depth: 4

View File

@@ -1,8 +1,8 @@
.. _recover-03x: .. _recover-03x:
=================================== ===================
Recover Embassy from Versions 0.3.x Recover v0.3.x Data
=================================== ===================
Recover Embassy Series 0.3.x Data Recover Embassy Series 0.3.x Data
--------------------------------- ---------------------------------

View File

@@ -1,8 +1,8 @@
.. _service-overview: .. _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<services>`, they are always ready to serve users! 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<services>`, they are always ready to serve users!

View File

@@ -1,8 +1,8 @@
.. _shoot-connection: .. _shoot-connection:
=========================== ===========
Troubleshooting Connections Connections
=========================== ===========
During initial setup, I am unable to connect to ``embassy.local``. 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<lan-setup>` instruc
I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
First, attmept to connect using :ref:`The Tor Browser<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<tor-os>` and/or to :ref:`Configure Your Browser<tor-firefox>`. First, attmept to connect using :ref:`The Tor Browser<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<tor-os>` and/or to :ref:`Configure Your Browser<tor-firefox>`.

View File

@@ -1,8 +1,8 @@
.. _shoot-embassy: .. _shoot-embassy:
======================= =======
Troubleshooting Embassy Embassy
======================= =======
Hardware Hardware
-------- --------

View File

@@ -1,8 +1,8 @@
.. _alt-marketplace: .. _alt-marketplace:
======================= ===============
Alternative Marketplace Alt Marketplace
======================= ===============
EmbassyOS supports accessing alternative marketplaces. EmbassyOS supports accessing alternative marketplaces.

View File

@@ -1,8 +1,8 @@
.. _advanced-config: .. _advanced-config:
====================== ===============
Advanced Configuration Advanced Config
====================== ===============
Custom options for folks that "know what they're doing." Custom options for folks that "know what they're doing."

View File

@@ -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``. and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``.
Software Wallets
----------------
.. _electrum: .. _electrum:
Electrum Electrum
-------- ========
Available for
.............
-Linux
**UNTESTED** **UNTESTED**
.. _fully-noded: .. _fully-noded:
FullyNoded FullyNoded
---------- ==========
.. note:: Mac only .. note:: Mac / iOS only
**UNTESTED**
.. _ledger-live:
Ledger Live
===========
.. tip:: Built for use with Ledger hardware devices
**UNTESTED** **UNTESTED**
.. _samourai: .. _samourai:
Samourai Samourai
-------- ========
.. note:: Android only .. note:: Android only
@@ -60,33 +76,25 @@ Samourai
.. _sparrow: .. _sparrow:
Sparrow Sparrow
------- =======
**UNTESTED** **UNTESTED**
.. _specter: .. _specter:
Specter Specter
------- =======
Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter Current - https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter
**UNTESTED** **UNTESTED**
.. _trezor: .. _trezor-suite:
Trezor Suite Trezor Suite
------------ ============
.. tip:: Built for use with Trezor hardware devices .. tip:: Built for use with Trezor hardware devices
**UNTESTED** **UNTESTED**
.. _ledger:
Ledger Live
-----------
.. tip:: Built for use with Ledger hardware devices
**UNTESTED**

View File

@@ -1,8 +1,8 @@
.. _service-guides: .. _service-guides:
======================= ==============
Service-Specific Guides Service Guides
======================= ==============
These guides will help you to setup external tools to connect or interact with specific :ref:`Services<services>`, such as a chat client or :ref:`Bitcoin<bitcoin>` wallet. These guides will help you to setup external tools to connect or interact with specific :ref:`Services<services>`, such as a chat client or :ref:`Bitcoin<bitcoin>` wallet.

View File

@@ -1,8 +1,8 @@
.. _tune-embassy-os: .. _tune-embassy-os:
===================== ===============
Customizing EmbassyOS Customizing EOS
===================== ===============
.. _device-name: .. _device-name:

View File

@@ -1,8 +1,8 @@
.. _error-logs: .. _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. 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.

View File

@@ -1,8 +1,8 @@
.. _overview: .. _overview:
===================== ==================
Overview of EmbassyOS EmbassyOS Overview
===================== ==================
.. _services-tab: .. _services-tab: