add indexd docs#177
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the docs to reflect the newer Sia storage architecture (hosted Sia Storage + self-hosted indexd indexer + clients/SDKs), adds first-party indexd setup documentation, and reorganizes “getting started” navigation to steer most users away from renterd as the default entry point.
Changes:
- Added new onboarding docs for Sia Storage usage,
indexdsetup (Docker Compose), and a “Which Sia software do I need?” overview page. - Updated many existing wallet/hosting/renting/integration pages for clearer, more consistent language and current product positioning (including multiple “
renterdis no longer preferred” notices). - Updated the sidebar structure (SUMMARY) and removed several Siafunds-related pages from the docs set.
Reviewed changes
Copilot reviewed 55 out of 59 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| wallet/wallet-overview.md | Reframes walletd as the primary standalone wallet; updates feature list. |
| wallet/transferring-siacoins.md | Tightens wording around sending/receiving and transaction status. |
| wallet/setting-up-walletd/windows.md | Clarifies Windows app purpose and setup phrasing. |
| wallet/setting-up-walletd/macos.md | Clarifies macOS app purpose and setup phrasing. |
| wallet/setting-up-walletd/linux/other.md | Improves Linux config guidance (notably config file placement/env var). |
| wallet/setting-up-walletd/docker.md | Clarifies Docker setup flow and reduces celebratory language. |
| v2/README.md | Edits v2 hardfork narrative for concision and tone. |
| v2/exchanges.md | Condenses the walletd exchange positioning paragraph. |
| testnet/zen-testnet.md | Simplifies Zen Testnet explanation and instructions. |
| SUMMARY.md | Reorganizes navigation; adds Sia Storage + indexd + software overview; removes some entries. |
| siafunds/sec-settlement-faq.md | Removes SEC settlement FAQ page. |
| siafunds/learn-about-siafunds.md | Removes “Learn about Siafunds” page. |
| siafunds/how-to-cash-out-siafunds.md | Removes “Withdrawing Siafunds” how-to page. |
| sia-integrations/using-the-sia-ledger-nano-s-app-wip.md | Simplifies Ledger Nano S overview phrasing and warnings. |
| sia-integrations/using-the-sia-ledger-nano-app-sia-central.md | Simplifies Ledger Nano overview phrasing. |
| sia-integrations/s3-integrations/rclone.md | Minor tightening of rclone description. |
| sia-integrations/s3-integrations/nextcloud.md | Minor wording and tone adjustments; trims “congratulations” phrasing. |
| sia-integrations/s3-integrations/jellyfin.md | Large intro simplification; minor wording adjustments throughout. |
| sia-integrations/brand-guidelines-for-sia-in-your-project-or-site-wip.md | Minor wording simplifications. |
| renting/using-sia-storage.md | New page introducing hosted Sia Storage and how to start. |
| renting/transferring-siacoins.md | Reframes transfers around funding/self-hosting indexd; clarifies screenshot scope. |
| renting/setting-up-renterd/windows.md | Adds “not preferred” notice; general wording cleanup. |
| renting/setting-up-renterd/README.md | Adds “not preferred” notice to renterd setup landing page. |
| renting/setting-up-renterd/macos.md | Adds “not preferred” notice; trims outdated config steps. |
| renting/setting-up-renterd/linux/ubuntu.md | Adds “not preferred” notice; fixes image path formatting. |
| renting/setting-up-renterd/linux/README.md | Adds “not preferred” notice; updates introductory wording. |
| renting/setting-up-renterd/linux/other.md | Removes Zen-specific tabs/commands; updates image paths; adds Zen note via config. |
| renting/setting-up-renterd/linux/debian.md | Adds “not preferred” notice; fixes image path formatting. |
| renting/setting-up-renterd/docker.md | Adds “not preferred” notice; minor wording cleanup. |
| renting/setting-up-indexd/README.md | New landing page explaining indexd, who should self-host, and prerequisites. |
| renting/setting-up-indexd/docker.md | New Docker Compose guide for running indexd with PostgreSQL. |
| renting/renting-storage/README.md | Adds “not preferred” notice and simplifies upload instructions. |
| renting/renting-storage/managing-your-files.md | Adds “not preferred” notice and simplifies maintenance wording. |
| renting/about-renting.md | Major rewrite describing clients/indexers/SDKs, direct-to-provider data path, and app model. |
| README.md | Updates homepage intro and adds “Where to start” entry points. |
| miscellaneous/siacoin-total-supply.md | Simplifies explanation of unlimited supply and inflation context. |
| miscellaneous/sia-brand-guidelines.md | Simplifies brand guideline wording and tone. |
| hosting/transferring-siacoins.md | Minor wording cleanup for sending/receiving. |
| hosting/setting-up-hostd/windows.md | Clarifies app purpose and setup phrasing. |
| hosting/setting-up-hostd/macos.md | Simplifies prerequisites wording and update phrasing. |
| hosting/setting-up-hostd/linux/ubuntu.md | Simplifies prerequisites wording; fixes image references. |
| hosting/setting-up-hostd/linux/README.md | Minor wording cleanup. |
| hosting/setting-up-hostd/linux/other.md | Improves Linux config guidance (notably config file placement/env var). |
| hosting/setting-up-hostd/linux/debian.md | Simplifies prerequisites wording. |
| hosting/setting-up-hostd/docker.md | Simplifies prerequisites wording and success/update phrasing. |
| hosting/configuring-your-host/README.md | Simplifies configuration intro and DDNS recommendations wording. |
| hosting/configuring-your-host/dynamic-dns/README.md | Fixes capitalization/grammar and simplifies DDNS benefit text. |
| hosting/configuring-your-host/dynamic-dns/duckdns.md | Simplifies DuckDNS intro wording. |
| hosting/configuring-your-host/dynamic-dns/cloudflare-advanced.md | Simplifies Cloudflare DDNS intro and call-to-action wording. |
| hosting/announcing-your-host.md | Simplifies announcement description and success message. |
| hosting/about-hosting-on-sia.md | Minor wording simplification; removes links to removed Siafund docs. |
| get-started-with-sia/the-importance-of-your-seed.md | Tightens seed safety wording and removes overly dramatic phrasing. |
| get-started-with-sia/sia101.md | Major rewrite to align with new storage stack terminology and entry points. |
| get-started-with-sia/sia-software-overview.md | New software overview page with a quick decision table and glossary. |
| get-started-with-sia/learn-about-siacoins.md | Minor heading/title and wording adjustments for clarity. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Setting up indexd | ||
|
|
||
| `indexd` is the Sia Foundation's indexer daemon. It is the component that **manages contracts** with storage providers, tracks where your objects live on the network, monitors their health, and repairs data in the background. Applications connect to an indexer (through a [Sia Storage SDK](../about-renting.md)) to store and retrieve data without managing hosts or contracts themselves. |
| ### walletd | ||
|
|
||
| `walletd` serves as a watch-only wallet server within the Sia ecosystem. It operates without access to private keys, solely managing addresses derived from those keys. Its primary function is to monitor the blockchain for events about specific addresses. | ||
| `walletd` is the standalone wallet server for Siacoin (and Siafund) wallets. It supports multiple wallets and hardware wallets such as Ledger, and can index either just your own addresses or the entire chain. It can hold your seeds to send and receive, or run watch-only — tracking addresses without access to private keys. |
Comment on lines
+24
to
+30
| # Where to start | ||
|
|
||
| * **Store your data** — the simplest way to start is the [Sia Storage app with a free Sia Storage account](renting/using-sia-storage.md) (50 GB). For how it works, see [About Storing Your Data](renting/about-renting.md). | ||
| * **Provide storage and earn Siacoin** — set up [`hostd`](hosting/about-hosting-on-sia.md). | ||
| * **Hold and manage Siacoin** — use [`walletd`](wallet/wallet-overview.md). | ||
| * **Build an application on Sia** — see the [Sia Developer Portal](https://devs.sia.storage). | ||
| * **Not sure which software you need?** — [Which Sia software do I need?](get-started-with-sia/sia-software-overview.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.