Skip to content

Commit

Permalink
GITBOOK-36: feature/doc-content(2)
Browse files Browse the repository at this point in the history
  • Loading branch information
n8maninger authored and gitbook-bot committed Sep 20, 2023
1 parent 37fd01c commit 7dc2e1a
Show file tree
Hide file tree
Showing 65 changed files with 859 additions and 898 deletions.
Binary file added .gitbook/assets/adding_volume.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/announce.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/bamboo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/check_status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/config_1 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/config_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/configure_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/creating volume list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/header.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/hostd r 0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/hostd r 1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/hostd r 2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/hostd_sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/introduction_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/introduction_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/introduction_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/introduction_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/jungle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/leaves.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/mountain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/qr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/sia_original.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/siacentral.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/siastats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/zen faucet funding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 33 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,60 @@
---
description: >-
Whether you're brand new to the Sia community or just need a refresher on the
basics, this article will get you up to speed.
cover: .gitbook/assets/header.jpeg
coverY: 0
---

# Welcome to Sia!
# Introduction

Sia is a decentralized cloud storage platform secured by blockchain technology. The Sia storage network leverages underutilized hard drive capacity around the world to create a data storage marketplace that is more reliable and lower cost than traditional cloud storage providers. Sia has its own blockchain, and a utility token that powers it – the Siacoin.
## Welcome to the Sia Docs!

Your data is truly private and gets stored across the globe to eliminate any single point of failure and ensure the highest possible uptime. Since you hold the keys, you own your data. No outside company can access or control your files.
The Sia Docs is your gateway to the remarkable world of decentralized cloud storage. Whether you're a tech-savvy enthusiast or someone who simply wants to explore the potential of the decentralization of cloud storage and data security, you've come to the right place!

Data cannot be de-platformed. Files can not be hacked.
Our documentation aims to provide a comprehensive source of information and serve as a beacon of knowledge for anyone interested in embracing the power of decentralized cloud storage.

## Sia is here for good
The information 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](https://web.archive.org/web/20180921135627/https://siawiki.tech/index), [SiaStats](https://siastats.info), and [SiaSetup](https://siasetup.info), and we aim educate our communitiy with what Sia has to offer!

Not only is your data safe on Sia, but you can feel confident that Sia isn't going anywhere. Sia has been in development for six years and has been live for five. The Sia software has been downloaded over a million times, and thousands of TB have been uploaded to the network since its inception. If the Sia dev team quit tomorrow, the network can autonomously run forever.
## Submitting your edits

Sia has a thriving community of renters, hosts, miners, data storage enthusiasts and an ecosystem of open source software and commercial data storage platforms. Discover the ecosystem on our [website's community and ecosystem page](https://sia.tech/community-ecosystem).
Keeping our documentation current is a substantial undertaking, and with GitBook, we've opened the door for community members to actively contribute ideas. Whether you want to suggest edits to existing content or create entirely new articles, you have the power to do so. 

{% hint style="warning" %}
All submissions, undergo a review and approval process by a member of the team, which means your commit won't be merged immediately.
{% endhint %}

{% hint style="warning" %}
You must have a GitHub account to submit an edit proposal. If you haven't already, please log in or create a GitHub account before you proceed.
{% endhint %}

***
1. To edit and submit a proposal via GitBook, click the **Page actions** (ellipsis) in the upper right corner of any page and click **Edit on GitHub**.

<div>
<figure><img src=".gitbook/assets/introduction_1.png" alt=""><figcaption><p>Selecting the page actions, and edit on Github</p></figcaption></figure>

<figure><img src=".gitbook/assets/twiiter_social_icon.png" alt="" width="32"><figcaption><p><a href="https://twitter.com/Sia__Foundation">Twitter</a></p></figcaption></figure>
After clicking **Edit on GitHub**, you'll be taken directly to the corresponding page on GitHub.

2. Next, click **Edit the file** (pencil icon) to begin editing the markdown file.

<figure><img src=".gitbook/assets/youtube_social_icon.png" alt="" width="32"><figcaption><p><a href="https://www.youtube.com/@SiaTVOfficial/playlists">Youtube</a></p></figcaption></figure>
<figure><img src=".gitbook/assets/introduction_2.png" alt=""><figcaption><p>Editing the markdown file via Github</p></figcaption></figure>


{% hint style="info" %}
Simply toggle the **Preview** button to see how the Markdown will be formatted on the GitBook documentation.&#x20;
{% endhint %}

<figure><img src=".gitbook/assets/discord_social_icon.png" alt="" width="32"><figcaption><p><a href="https://discord.com/invite/sia">Discord</a></p></figcaption></figure>
3. Once you make your changes/additions to the markdown, click the **Commit Changes** button in the top right corner. Remember to do the following:
* Select the **"Create a new branch for the commit and start a pull request"** option.
* Add a reasonable title for this commit change(s) in the commit message textbox.
* In the extended description section, provide A brief description of the changes/additions made in this commit. If possible provide any links to resources that help you with your decision to contribute.

<figure><img src=".gitbook/assets/introduction_3.png" alt=""><figcaption><p>Committing changes and edits via Github</p></figcaption></figure>

<figure><img src=".gitbook/assets/reddit_social_icon.png" alt="" width="32"><figcaption><p><a href="https://www.reddit.com/r/siacoin">Reddit</a></p></figcaption></figure>
4. Once you're satisfied, click **Commit Changes** to submit your proposal&#x20;

## Further assistance

<figure><img src=".gitbook/assets/287725_github_icon.png" alt="" width="32"><figcaption><p><a href="https://github.com/SiaFoundation">Github</a></p></figcaption></figure>
Couldn’t find your answer here in our documentation? Don’t worry, we have more support options for you.

Join the `#help` channel in the [Sia Discord](https://discord.com/invite/sia) where we have a huge community that loves helping users with their issues.

<figure><img src=".gitbook/assets/siaforum_social_icon.png" alt="" width="54"><figcaption><p><a href="https://forum.sia.tech">Forum</a></p></figcaption></figure>
You can also [send us an email.](mailto:hello@sia.tech) We’ll respond as soon as we can.



<figure><img src=".gitbook/assets/medium_social_icon.png" alt="" width="32"><figcaption><p><a href="https://blog.sia.tech">Blog</a></p></figcaption></figure>

</div>
53 changes: 22 additions & 31 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,49 @@
# Table of contents

* [Welcome to Sia!](README.md)
* [Introduction](README.md)

## Get Started with Sia

* [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)
* [Learn about Sia](get-started-with-sia/sia101.md)
* [Learn about Siacoins](get-started-with-sia/learn-about-siacoins.md)
* [Your Sia 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)
* [About Renting on Sia](renting/about-renting.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)
* [✏ Windows](renting/setting-up-renterd/windows.md)
* [✏ Linux](renting/setting-up-renterd/linux.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)
* [Managing your Files](renting/managing-your-files.md)

## Hosting

* [About Hosting on Sia](hosting/about-hosting-on-sia.md)
* [🚧 Setting up hostd](hosting/setup-guides/README.md)
* [Linux](hosting/setup-guides/linux.md)
* [Setting up hostd](hosting/setup-guides/README.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)
* [✏ Windows](hosting/setup-guides/windows.md)
* [✏ Linux](hosting/setup-guides/linux.md)
* [Transferring Siacoins](hosting/transferring-siacoins.md)
* [Adding Storage](hosting/adding-storage.md)
* [Configuring your Host](hosting/configuring-your-host/README.md)
* [Dynamic DNS](hosting/configuring-your-host/dynamic-dns/README.md)
* [DuckDNS](hosting/configuring-your-host/dynamic-dns/duckdns.md)
* [Cloudflare](hosting/configuring-your-host/dynamic-dns/cloudflare-advanced.md)
* [Announcing your Host](hosting/announcing-your-host.md)
* [Hosting FAQ](hosting/hosting-faq.md)

## Wallet

* [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)
* [📸 Linux](wallet/setting-up-walletd/linux.md)
* [Transferring Siacoins](wallet/transferring-siacoins.md)
* [🚧 Wallet FAQ](wallet/wallet-faq.md)

## Mining

* [About Mining on Sia](mining/about-mining-on-sia.md)
* [Sia mining pools](mining/sia-mining-pools.md)

## Siafunds

Expand All @@ -61,14 +53,13 @@

## Sia Integrations

* [🚧 Listing Siacoin on your exchange](sia-integrations/listing-siacoin-on-your-exchange.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](sia-integrations/sia-brand-guidelines.md)
* [Brand Guidelines](sia-integrations/sia-brand-guidelines.md)

## Testnet

* [🚧 What is Zen?](testnet/what-is-zen.md)
* [Zen Testnet](testnet/zen-testnet.md)

## Miscellaneous

Expand Down
35 changes: 0 additions & 35 deletions get-started-with-sia/intro.md

This file was deleted.

Loading

0 comments on commit 7dc2e1a

Please sign in to comment.