GITBOOK-33: feature/docs-content(1)

SiaFoundation · Sep 5, 2023 · 37fd01c · 37fd01c
1 parent de3aa97
commit 37fd01c
Show file tree

Hide file tree

Showing 88 changed files with 1,057 additions and 688 deletions.
diff --git a/.gitbook/assets/host_1.png b/.gitbook/assets/host_1.png
diff --git a/.gitbook/assets/host_2.png b/.gitbook/assets/host_2.png
diff --git a/.gitbook/assets/host_3.png b/.gitbook/assets/host_3.png
diff --git a/.gitbook/assets/host_4.png b/.gitbook/assets/host_4.png
diff --git a/.gitbook/assets/host_5.png b/.gitbook/assets/host_5.png
diff --git a/.gitbook/assets/macos_1.png b/.gitbook/assets/macos_1.png
diff --git a/.gitbook/assets/option.png b/.gitbook/assets/option.png
diff --git a/.gitbook/assets/receieve_2.png b/.gitbook/assets/receieve_2.png
diff --git a/.gitbook/assets/receieving_1.png b/.gitbook/assets/receieving_1.png
diff --git a/.gitbook/assets/receiving_3 (1).png b/.gitbook/assets/receiving_3 (1).png
diff --git a/.gitbook/assets/receiving_3.png b/.gitbook/assets/receiving_3.png
diff --git a/.gitbook/assets/receiving_4.png b/.gitbook/assets/receiving_4.png
diff --git a/.gitbook/assets/renter_1.png b/.gitbook/assets/renter_1.png
diff --git a/.gitbook/assets/renter_7.png b/.gitbook/assets/renter_7.png
diff --git a/.gitbook/assets/renterd_10.png b/.gitbook/assets/renterd_10.png
diff --git a/.gitbook/assets/renterd_11.png b/.gitbook/assets/renterd_11.png
diff --git a/.gitbook/assets/renterd_12.png b/.gitbook/assets/renterd_12.png
diff --git a/.gitbook/assets/renterd_13.png b/.gitbook/assets/renterd_13.png
diff --git a/.gitbook/assets/renterd_14.png b/.gitbook/assets/renterd_14.png
diff --git a/.gitbook/assets/renterd_2.png b/.gitbook/assets/renterd_2.png
diff --git a/.gitbook/assets/renterd_3.png b/.gitbook/assets/renterd_3.png
diff --git a/.gitbook/assets/renterd_4.png b/.gitbook/assets/renterd_4.png
diff --git a/.gitbook/assets/renterd_5.png b/.gitbook/assets/renterd_5.png
diff --git a/.gitbook/assets/renterd_6.png b/.gitbook/assets/renterd_6.png
diff --git a/.gitbook/assets/renterd_8.png b/.gitbook/assets/renterd_8.png
diff --git a/.gitbook/assets/renterd_9.png b/.gitbook/assets/renterd_9.png
diff --git a/.gitbook/assets/sending_1.png b/.gitbook/assets/sending_1.png
diff --git a/.gitbook/assets/sending_2.png b/.gitbook/assets/sending_2.png
diff --git a/.gitbook/assets/sending_3.png b/.gitbook/assets/sending_3.png
diff --git a/.gitbook/assets/sending_4.png b/.gitbook/assets/sending_4.png
diff --git a/.gitbook/assets/sending_5.png b/.gitbook/assets/sending_5.png
diff --git a/.gitbook/assets/terminal 1.png b/.gitbook/assets/terminal 1.png
diff --git a/.gitbook/assets/terminal 2.png b/.gitbook/assets/terminal 2.png
diff --git a/.gitbook/assets/walletd_ui.png b/.gitbook/assets/walletd_ui.png
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -4,82 +4,74 @@
 
 ## Get Started with Sia
 
-* [Introduction to these docs](get-started-with-sia/intro.md)
-* [🚧 Sia 101](get-started-with-sia/sia101.md)
-* [What are Siacoins?](get-started-with-sia/what-are-siacoins.md)
-* [How to buy Siacoins](get-started-with-sia/how-to-buy-siacoins.md)
+* [Introduction](get-started-with-sia/intro.md)
+* [🚧 Learn about Sia](get-started-with-sia/sia101.md)
+* [🚧 Learn about Siacoins](get-started-with-sia/learn-about-siacoins.md)
 * [🚧 The importance of your seed](get-started-with-sia/the-importance-of-your-seed.md)
 * [Siacoin Total Supply](get-started-with-sia/siacoin-total-supply.md)
 
 ## Renting
 
 * [🚧 About Renting on Sia](renting/about-renting.md)
-* [🚧 Setup Guides](renting/setup-guides/README.md)
-  * [Linux](renting/setup-guides/linux.md)
-  * [macOS](renting/setup-guides/macos.md)
-  * [Windows](renting/setup-guides/windows.md)
-* [🚧 Renting storage on Sia](renting/renting-storage-on-sia.md)
-* [🚧 Managing your files](renting/managing-your-files.md)
-* [🚧 Back up and restore your files](renting/how-to-back-up-your-files.md)
-* [🚧 Renter troubleshooting](renting/renter-troubleshooting.md)
+* [Setting up renterd](renting/setting-up-renterd/README.md)
+  * [🚧 Linux](renting/setting-up-renterd/linux.md)
+  * [macOS](renting/setting-up-renterd/macos.md)
+  * [🚧 Windows](renting/setting-up-renterd/windows.md)
+* [📷 Transferring Siacoins](renting/transferring-siacoins.md)
+* [Renting Storage](renting/renting-storage.md)
+* [Managing Files](renting/managing-your-files.md)
 * [🚧 Renting FAQ](renting/renting-faq.md)
 
 ## Hosting
 
 * [About Hosting on Sia](hosting/about-hosting-on-sia.md)
-* [🚧 Setup Guides](hosting/setup-guides/README.md)
+* [🚧 Setting up hostd](hosting/setup-guides/README.md)
   * [Linux](hosting/setup-guides/linux.md)
   * [macOS](hosting/setup-guides/macos.md)
   * [Windows](hosting/setup-guides/windows.md)
+* [🚧 Transferring Siacoins](hosting/transferring-siacoins.md)
+* [🚧 Adding Storage](hosting/adding-storage.md)
+* [🚧 Configuring your Host](hosting/configuring-your-host.md)
+* [🚧 Announcing your Host](hosting/announcing-your-host.md)
 * [Dynamic DNS](hosting/dynamic-dns/README.md)
   * [DuckDNS](hosting/dynamic-dns/duckdns.md)
   * [Cloudflare (Advanced)](hosting/dynamic-dns/cloudflare-advanced.md)
 * [Hosting FAQ](hosting/hosting-faq.md)
 
 ## Wallet
 
-* [🚧 About Wallet](wallet/wallet-overview.md)
-* [🚧 Setup Guide](wallet/setup-guide/README.md)
-  * [Linux](wallet/setup-guide/linux.md)
-  * [macOS](wallet/setup-guide/macos.md)
-  * [Windows](wallet/setup-guide/windows.md)
+* [About walletd](wallet/wallet-overview.md)
+* [Setting up walletd](wallet/setting-up-walletd/README.md)
+  * [📸 Linux](wallet/setting-up-walletd/linux.md)
+  * [macOS](wallet/setting-up-walletd/macos.md)
+  * [📸 Windows](wallet/setting-up-walletd/windows.md)
+* [Transferring Siacoins](wallet/transferring-siacoins.md)
 * [🚧 Wallet FAQ](wallet/wallet-faq.md)
 
-## Your Sia Wallet
-
-* [Overview](your-sia-wallet/overview.md)
-* [🚧 Siacoin Transfer](your-sia-wallet/siacoin-transfer/README.md)
-  * [Send](your-sia-wallet/siacoin-transfer/send.md)
-  * [Recieve](your-sia-wallet/siacoin-transfer/recieve.md)
-* [🚧 Deposit](your-sia-wallet/wallet-overview.md)
-* [🚧 Withdrawal](your-sia-wallet/withdrawal.md)
-
 ## Mining
 
-* [About mining on Sia](mining/about-mining-on-sia.md)
+* [About Mining on Sia](mining/about-mining-on-sia.md)
 * [Sia mining pools](mining/sia-mining-pools.md)
 
 ## Siafunds
 
-* [What are Siafunds?](siafunds/what-are-siafunds.md)
-* [How do I buy Siafunds?](siafunds/how-do-i-buy-siafunds.md)
+* [Learn about Siafunds](siafunds/learn-about-siafunds.md)
 * [How to cash out Siafunds](siafunds/how-to-cash-out-siafunds.md)
 * [SEC Settlement FAQ](siafunds/sec-settlement-faq.md)
 
 ## Sia Integrations
 
 * [🚧 Listing Siacoin on your exchange](sia-integrations/listing-siacoin-on-your-exchange.md)
-* [Using the Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md)
+* [Using Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md)
 * [Using the Sia Ledger Nano app with CLI](sia-integrations/using-the-sia-ledger-nano-app-cli.md)
-* [🚧 Brand guidelines for Sia in your project or site](sia-integrations/sia-brand-guidelines.md)
+* [🚧 Brand Guidelines](sia-integrations/sia-brand-guidelines.md)
 
 ## Testnet
 
 * [🚧 What is Zen?](testnet/what-is-zen.md)
 
 ## Miscellaneous
 
-* [🚧 Version matrix](miscellaneous/version-matrix.md)
-* [👷 Learn more and contribute](miscellaneous/learn-more-and-contribute.md)
-* [🚧 Code of Conduct](miscellaneous/code-of-conduct.md)
+* [🚧 Releases](miscellaneous/releases.md)
+* [Getting Involved](miscellaneous/getting-involved.md)
 * [🚧 Glossary](miscellaneous/glossary.md)
diff --git a/get-started-with-sia/how-to-buy-siacoins.md b/get-started-with-sia/how-to-buy-siacoins.md
diff --git a/get-started-with-sia/intro.md b/get-started-with-sia/intro.md
@@ -1,10 +1,10 @@
-# Introduction to these docs
+# Introduction
 
 The goal of the Sia Docs is to be a comprehensive source of Sia information. Info in these docs has been taken from a number of sources, primarily the previous Sia Support Center and community-driven sites like the Sia Wiki, SiaStats, and SiaSetup. Thanks to these sites and the many others that have contributed to the Sia ecosystem over the years.
 
 Keeping docs up to date is no small task, and GitBook allows anyone in the community to submit an edit to a document, or even a completely new article on their own. While we still need to review and approve submissions, the pipeline to getting docs updated is significantly cleaner than it used to be.
 
-While this site can be updated by our users, a community never suffers from having too many resources. Where this site takes a targeted approach to on-boarding new users and getting them up and running, another site might take a more philosophical approach. Yet another might focus on metrics. There's nothing wrong with redundancy – the entire Sia network is based on it.
+While this site can be updated by our users, a community never suffers from having too many resources. Where this site takes a targeted approach to onboarding new users and getting them up and running, another site might take a more philosophical approach. Yet another might focus on metrics. There's nothing wrong with redundancy – the entire Sia network is based on it.
 
 ### Submit your edits!
 

diff --git a/get-started-with-sia/learn-about-siacoins.md b/get-started-with-sia/learn-about-siacoins.md
@@ -0,0 +1,40 @@
+# 🚧 Learn about Siacoins
+
+## What are Siacoins?
+
+Siacoins are the utility tokens that power the Sia network. This article is included early on because anything you want to do on the network requires Siacoins.
+
+Siacoins are used in lots of ways but serve a single purpose – facilitating network operations. When you upload files to Sia, you pay for that storage in Siacoins. If you're a host and you're storing other people's data, you get paid for that in Siacoins. If you own Siafunds, your share of Sia network growth is paid out in, you guessed it, Siacoins.
+
+You can send Siacoins to others, or receive them at your own wallet address. You can store them in our official software, or on a hardware or paper wallet. You can get Siacoins by having someone send them to you, buying them on an exchange, or mining them.
+
+New Siacoins are made through proof-of-work mining. There are over 40 billion Siacoins out there right now, and that number will never stop growing. Sia is going to be the storage layer of the internet, and billions will be required for the petabytes and exabytes of data that will be stored on Sia.
+
+## Where to buy Siacoins
+
+Whether you want to upload files to the decentralized cloud or lend your extra storage space to the network, you need Siacoins to use Sia. Siacoins can be sent to you once you make a Sia address, or you can mine them. Otherwise, you’ll need to buy them.
+
+Siacoins are available on a number of major exchanges like Binance, Kraken, Upbit, and Poloniex. Get the full list [here](https://sia.tech/community-ecosystem?software=exchanges#software).
+
+Some exchanges support direct fiat (local currency) to Siacoin purchases, but others require you to buy Bitcoins, Ethereum, or other crypto to make your purchase. We’ll walk you through the process of buying your first Siacoins.
+
+### Buy SC from an exchange
+
+This option gets you the best prices but has a fairly intense on-ramp for a new user.
+
+This example will use [Kraken](https://kraken.com), a US-based exchange that allows you to trade regular US dollars (USD), BTC, ETH, or USDT for Siacoins. But the general process will be similar no matter which exchange you use.
+
+* [Sign up for an account](https://bittrex.zendesk.com/hc/en-us/articles/115005329167-Creating-a-Bittrex-Account-and-Performing-Verification) with Kraken. The process is simple, but fairly long and requires identity verification along the way.
+* Once signed up, find the market you’re interested in. Purchase directly with [USD](https://bittrex.com/Market/Index?MarketName=USD-SC) or [Bitcoin](https://bittrex.com/Market/Index?MarketName=BTC-SC).
+* Make a trade by specifying how many Siacoins you want to buy, and at what price.
+
+{% hint style="warning" %}
+If this is your first time purchasing crypto, start with a small amount until you’re comfortable with it.
+{% endhint %}
+
+* Now you have the Siacoins in your Kraken wallet, but exchange wallets aren’t a good place to store crypto, and you can’t use it for its intended purpose - using Sia.
+* Transfer to your Sia wallet by [making a Sia address](broken-reference) and then withdrawing from Kraken.
+
+Then enter in your SC address [that you made](broken-reference), and click **Buy Now** again to proceed through the transaction process.
+
+##
diff --git a/get-started-with-sia/sia101.md b/get-started-with-sia/sia101.md
@@ -2,7 +2,7 @@
 description: Let's take it from the top.
 ---
 
-# 🚧 Sia 101
+# 🚧 Learn about Sia
 
 Sia has a few important terms that you'll want to get familiar with. These will be explained in more detail in their related sections, but here's a short sample.
 
@@ -19,16 +19,12 @@ When a file gets uploaded to Sia, it gets split up, encrypted, and sent all over
 
 ## Why it's here
 
-Sia’s core goal is to bring decentralization to data storage. We want you to be able to store your data in a way that gives you full, exclusive control. We want to make sure you're protected against theft, censorship, and that you are never denied access to your data by hackers, miners, developers, or a government body. Your data belongs to you.
+Sia’s core goal is to bring decentralization to data storage. We want you to be able to store your data in a way that gives you full, exclusive control. We want to ensure you're protected against theft and censorship, and that you are never denied access to your data by hackers, miners, or developers. Your data belongs to you.
 
 ## Who makes Sia?
 
 Sia was conceived at HackMIT in 2013 by David Vorick and Luke Champine. The founders formed Nebulous Labs and later Skynet Labs to develop Sia. More recently, the Sia Foundation was formed as a non-profit dedicated to leading core development into the future.
 
-## Community contribution
-
-While there is a distinct development and operations team, dozens of individuals have contributed to the core code or apps built on top of the network. Check out our [GitHub repositories](https://github.com/SiaFoundation) if you're interested in following along or writing code for Sia and further decentralizing the project!
-
 ## **Renting on Sia**
 
 When you upload files to Sia, you become a **renter**. You upload files to other users who have made their space available, called **hosts**. We use the term renter because Sia creates contracts with other hosts:
@@ -47,21 +43,12 @@ Hosts are a critical part of the ecosystem. You are contributing to the decentra
 
 ## The Sia core software
 
-{% hint style="info" %}
-Please note that while much of the documentation is written for `siad` and Sia-UI. We are actively transitioning to `renterd`, `hostd`, and `walletd` and will be updating all documentation to reflect this new software.
-{% endhint %}
-
-The original core Sia software consists of `siad` and Sia-UI. This software is currently being deprecated and replaced with the new software outlined below.
-
-* **`siad`** is a daemon that can be used via CLI. `siad` supports renting, hosting, wallets, and more - essentially all-in-one software for using Sia.&#x20;
-* **Sia-UI** is `siad` wrapped with a graphical user interface.
-
 The Sia Foundation has been developing a new suite of software that improves on `siad` and takes a more modular approach, with separate software for renting, hosting, wallet, and explorer. The software is generally more scalable, performant, and easier to integrate.
 
 The new software is:
 
-* **`renterd`** is a next-generation Sia renter, developed by the Sia Foundation. It aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their personal data -- and developers -- who want to a powerful, flexible, and reliable API for building apps on Sia.&#x20;
-* **`hostd`** is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. `hostd` incorporates an embedded web-UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices.
+* **`renterd`** is a next-generation Sia renter, developed by the Sia Foundation. It aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their personal data -- and developers -- who want a powerful, flexible, and reliable API for building apps on Sia.&#x20;
+* **`hostd`** is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. `hostd` incorporates an embedded web UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices.
 * **`walletd`** is a watch-only wallet server. It does not have access to any private keys, only addresses derived from those keys. Its role is to watch the blockchain for events relevant to particular addresses. The server therefore knows which outputs are spendable by the wallet at any given time, and can assist in constructing and broadcasting transactions spending those outputs. However, _signing_ transactions is the sole responsibility of the client.
 * **`explored`** An explorer backend for Sia.