From 41473f34ead73d7e72f71f9de0f233aae0a01b33 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Wed, 25 Sep 2024 16:27:37 -0600 Subject: [PATCH 01/40] Wayfinding Homepage --- src/pages/index.mdx | 47 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 4260348ad..82fcf5c93 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -12,6 +12,53 @@ The developer docs will teach you how to build applications, issue and use token If you can’t find answers to your questions in the docs, search for your answer or ask questions in our [Stellar Developer Discord](https://discord.gg/stellardev) or [Stack Exchange](https://stellar.stackexchange.com/). +## Stellar wayfinding based on audience type + +### Stellar for asset issuers + +| **Stellar Assets** | | | +| :-- | --- | --- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | +| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | +| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | +| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | + +| **Custom Tokens** | | | +| :-- | --- | --- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | +| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | +| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | + +### Stellar for smart contract developers + +| **Contract Devs** | | | +| :-- | --- | --- | +| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | +| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks here | +| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them here | +| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | +| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | +| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | + +## Stellar for ramps (anchors) + +| **Ramps** | | | +| :-- | --- | --- | +| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | +| **Learn** | SEP-6 and SEP-24 | You can set up an anchor using SEP-6 or SEP-24, learn about the differences here | +| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | +| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | +| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | +| **Tool** | Anchor test suite | | + ## Navigating the docs From 645c5f44a89ae503a78c127d0cd54e64707a030d Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Mon, 30 Sep 2024 11:35:13 -0600 Subject: [PATCH 02/40] add table of contents --- src/pages/index.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 82fcf5c93..49748b750 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -1,7 +1,3 @@ ---- -hide_table_of_contents: true ---- - import WayfindingBoxes from "@site/src/components/WayfindingBoxes"; # Welcome to Stellar Developer Docs From 0c8abb275e265c756da22a66510f00a676aea7e1 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Wed, 2 Oct 2024 10:39:00 -0600 Subject: [PATCH 03/40] More updates --- src/pages/index.mdx | 57 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 49748b750..0c6a1105a 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -13,7 +13,7 @@ If you can’t find answers to your questions in the docs, search for your answe ### Stellar for asset issuers | **Stellar Assets** | | | -| :-- | --- | --- | +| :-: | :-- | :-- | | **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | | **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | | **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | @@ -22,7 +22,7 @@ If you can’t find answers to your questions in the docs, search for your answe | **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | | **Custom Tokens** | | | -| :-- | --- | --- | +| :-: | :-- | :-- | | **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | | **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | | **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | @@ -34,7 +34,7 @@ If you can’t find answers to your questions in the docs, search for your answe ### Stellar for smart contract developers | **Contract Devs** | | | -| :-- | --- | --- | +| :-: | --- | --- | | **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | | **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks here | | **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them here | @@ -44,10 +44,15 @@ If you can’t find answers to your questions in the docs, search for your answe | **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | | **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | -## Stellar for ramps (anchors) +| **Contract Devs (optional pages)** | | | +| :-: | --- | --- | +| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset. | +| **Guide** | [Upgrading contracts](https://developers.stellar.org/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | + +### Stellar for ramps (anchors) | **Ramps** | | | -| :-- | --- | --- | +| :-: | --- | --- | | **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | | **Learn** | SEP-6 and SEP-24 | You can set up an anchor using SEP-6 or SEP-24, learn about the differences here | | **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | @@ -55,7 +60,47 @@ If you can’t find answers to your questions in the docs, search for your answe | **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | | **Tool** | Anchor test suite | | - +### Stellar for applications + +| **Traditional wallets** | | | +| :---------------------: | ------------- | -------------------- | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | + +| **Decentralized applications** | | | +| :----------------------------: | ------------- | -------------------- | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | + +| **Exchanges** | | | +| :-: | --- | --- | +| **Tools** | [SDKs](https://developers.stellar.org/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | +| **Learn** | `insert link` | `insert description` | + +### Stellar for infrastructure providers + +| **Horizon** | | | +| :-: | --- | --- | +| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | | +| **Guide** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | | +| **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | | +| **Tools** | [Tools](https://developers.stellar.org/docs/tools/sdks/library) | | + +| **RPC** | | | +| :-: | --- | --- | +| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | | +| **Guide** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | | +| **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | | +| **Tools** | [Tools](https://developers.stellar.org/docs/tools/sdks/library) | | ## Navigating the docs From ae317cfb3dfe2d2cde2f78946d1c500106346800 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Thu, 3 Oct 2024 15:18:35 -0600 Subject: [PATCH 04/40] Add descriptions + SEP-6, SEP-24 wayfinding --- docs/learn/fundamentals/anchors.mdx | 30 ++++++++++++++++++++++++++++- src/pages/index.mdx | 18 ++++++++--------- 2 files changed, 38 insertions(+), 10 deletions(-) diff --git a/docs/learn/fundamentals/anchors.mdx b/docs/learn/fundamentals/anchors.mdx index 1f94f3cad..a47c76720 100644 --- a/docs/learn/fundamentals/anchors.mdx +++ b/docs/learn/fundamentals/anchors.mdx @@ -3,6 +3,8 @@ title: Anchors sidebar_position: 90 --- +## Overview + An anchor is a Stellar-specific term for the on and off-ramps that connect the Stellar network to traditional financial rails, such as financial institutions or fintech companies. Anchors accept deposits of fiat currencies (such as the US dollar, Argentine peso, or Nigerian naira) via existing rails (such as bank deposits or cash-in points), then sends the user the equivalent digital tokens on the Stellar network. The equivalent digital tokens can either represent that same fiat currency or another digital token altogether. Alternatively, anchors allow token holders to redeem their tokens for the real-world assets they represent. Stellar has anchor services operating worldwide. View the [Anchor Directory](https://resources.stellar.org/anchors?) for more information on existing Stellar anchors. @@ -13,7 +15,7 @@ You can set up an anchor by using the SDF-maintained [Anchor Platform](/platform Learn how to integrate anchor services into your blockchain-based application by viewing the [Build Apps section](../../build/apps/overview.mdx). If you’re looking specifically for MoneyGram Access, see the Integrate with MoneyGram Access tutorial. -### Stellar Ecosystem Proposals (SEPs) +## Stellar Ecosystem Proposals (SEPs) Stellar is an open-source network that is designed to interoperate with traditional financial institutions, various types of assets, and other networks. Network participants implement Stellar Ecosystem Proposals (SEPs) to ensure they can interoperate with other products and services on the network. SEPs are publicly created, open-source documents that live in a [GitHub repository](https://github.com/stellar/stellar-protocol/tree/master/ecosystem#stellar-ecosystem-proposals-seps.mdx) and they define how anchors, asset issuers, applications, exchanges, and other service providers should interact and interoperate. @@ -29,3 +31,29 @@ For anchors, the most important SEPs are [SEP-6]: Programmatic Deposit and Withd [sep-24]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md [sep-31]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md [sep-38]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md + +### Using SEP-6: Programmatic Deposit and Withdrawal versus SEP-24: Hosted Deposit and Withdrawal + +A user typically must decide whether they want to set up an anchor using [SEP-6: Programmatic Deposit and Withdrawal](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md) or [SEP-24: Hosted Deposit and Withdrawal](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md). Here are the differences and what to consider when choosing one or the other. + +#### SEP-6: Programmatic Deposit and Withdrawal + +Defines the standard way for anchors and wallets to interact on behalf of users. With this SEP’s guidance, wallets and other clients can interact with anchors directly without the user needing to leave the wallet to go to the anchor’s site. With SEP-6, the client collects KYC information from the user. + +Wallets (clients) must take into consideration when using SEP-6: + +- Clients must collect KYC information they may not need +- Clients must know what information to collect per-anchor +- Clients must send the information in a standardized format [(SEP-12: KYC API)](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) +- Anchors must receive the information via SEP-12’s API + +#### SEP-24: Hosted Deposit and Withdrawal + +Defines the standard way for anchors and wallets to interact on behalf of users interactively. This means that the user’s application must open a webview hosted by a third-party anchor for the user to provide the information necessary to complete the transaction. With SEP-24, the anchor collects KYC information from the user. + +Wallets (clients) must take into consideration when using SEP-24: + +- Clients don’t have to collect the anchor’s required KYC information +- Clients & anchors don’t have to implement [SEP-12: KYC API](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) +- Anchors must create a UI to be rendered by many clients +- Clients must allow anchors to temporarily control UX diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 0c6a1105a..a23dacef9 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -54,7 +54,7 @@ If you can’t find answers to your questions in the docs, search for your answe | **Ramps** | | | | :-: | --- | --- | | **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | -| **Learn** | SEP-6 and SEP-24 | You can set up an anchor using SEP-6 or SEP-24, learn about the differences here | +| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences here | | **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | | **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | | **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | @@ -90,17 +90,17 @@ If you can’t find answers to your questions in the docs, search for your answe | **Horizon** | | | | :-: | --- | --- | -| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | | -| **Guide** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | | -| **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | | -| **Tools** | [Tools](https://developers.stellar.org/docs/tools/sdks/library) | | +| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | +| **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | +| **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | +| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | text | | **RPC** | | | | :-: | --- | --- | -| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | | -| **Guide** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | | -| **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | | -| **Tools** | [Tools](https://developers.stellar.org/docs/tools/sdks/library) | | +| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | +| **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | +| **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | +| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | text | ## Navigating the docs From 1bbb89d67b080c27eca7b3bff176504cc41e2447 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:08:31 -0600 Subject: [PATCH 05/40] More wayfinding --- src/pages/index.mdx | 63 +++++++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 28 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index a23dacef9..1a9b6ad73 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -10,6 +10,12 @@ If you can’t find answers to your questions in the docs, search for your answe ## Stellar wayfinding based on audience type +:::note + +There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs in finding necessary conceptual information, tutorials, data availability recommendations, and more based on what you're trying to accomplish. + +::: + ### Stellar for asset issuers | **Stellar Assets** | | | @@ -62,29 +68,30 @@ If you can’t find answers to your questions in the docs, search for your answe ### Stellar for applications -| **Traditional wallets** | | | -| :---------------------: | ------------- | -------------------- | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | - -| **Decentralized applications** | | | -| :----------------------------: | ------------- | -------------------- | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | +| **Traditional wallets** | | | +| :-: | --- | --- | +| **Learn** | [Application design considerations](https://developers.stellar.org/docs/build/apps/application-design-considerations) | Various concepts to consider when building a wallet, such as custody models, security, and more | +| **Learn** | [Fees](https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee) | Learn about how fees work on the Stellar network and decide how you'd like to handle user fees | +| **Learn** | [Operations & transactions](https://developers.stellar.org/docs/learn/fundamentals/transactions) | Wallets build and submit transactions, learn about about how operations and transactions work here | +| **Learn** | [Signatures & multisig](https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig) | Signatures are authorization for transactions on the Stellar network, learn about them here | +| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Wallets may want to connect to financial rails via anchors (on- and off-ramps), learn about them here | +| **Tutorial** | [Wallet SDK](https://developers.stellar.org/docs/category/build-a-wallet-with-the-wallet-sdk) | Learn to build a wallet with the Wallet SDK in Kotlin, Flutter, or TypeScript | +| **Data** | [Horizon introduction](https://developers.stellar.org/docs/data/horizon) | Access network data using the Horizon REST API | + +| **Decentralized applications** | _Start by viewing the smart contract wayfinding section_ | | +| :-: | --- | --- | +| **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | +| **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | +| **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | +| **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | +| **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | +| **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC | | **Exchanges** | | | | :-: | --- | --- | | **Tools** | [SDKs](https://developers.stellar.org/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | -| **Learn** | `insert link` | `insert description` | +| **Data** | [Run your own RPC](https://developers.stellar.org/docs/data/rpc/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | +| **Data** | [Run your own Horizon](https://developers.stellar.org/docs/data/horizon/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | ### Stellar for infrastructure providers @@ -93,42 +100,42 @@ If you can’t find answers to your questions in the docs, search for your answe | **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | | **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | -| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | text | +| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | | **RPC** | | | | :-: | --- | --- | | **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | | **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | -| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | text | +| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the RPC setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | ## Navigating the docs -### [Build](/docs/build) +#### [Build](/docs/build) Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. -### [Learn](/docs/learn/fundamentals) +#### [Learn](/docs/learn/fundamentals) Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. -### [Tokens](/docs/tokens) +#### [Tokens](/docs/tokens) Information on how to issue assets on the Stellar network and create custom smart contract tokens. -### [Data](/docs/data) +#### [Data](/docs/data) Discover various data availability options: RPC, Hubble, and Horizon. -### [Tools](/docs/tools) +#### [Tools](/docs/tools) Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. -### [Networks](/docs/networks) +#### [Networks](/docs/networks) Information about delpoyed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. -### [Validators](/docs/validators) +#### [Validators](/docs/validators) Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. From bd4ac72c2445dbbf482b0d4c1887029f6c95770c Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:24:36 -0600 Subject: [PATCH 06/40] words --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 1a9b6ad73..02eed424b 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -12,7 +12,7 @@ If you can’t find answers to your questions in the docs, search for your answe :::note -There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs in finding necessary conceptual information, tutorials, data availability recommendations, and more based on what you're trying to accomplish. +There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs to find necessary conceptual information, tutorials, data availability recommendations, and more based on what you're trying to accomplish. ::: From a471f4fc387a04837cdc2d864c76304a96e5b057 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Mon, 28 Oct 2024 14:12:10 -0600 Subject: [PATCH 07/40] playing around with formatting --- src/pages/index.mdx | 187 +++++++++++++++++++++++++++++++------------- 1 file changed, 133 insertions(+), 54 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 02eed424b..f108d2564 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -16,59 +16,116 @@ There's much more you can do with the Stellar network than what's listed below! ::: -### Stellar for asset issuers - -| **Stellar Assets** | | | -| :-: | :-- | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | -| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | -| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | -| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | - -| **Custom Tokens** | | | -| :-: | :-- | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | -| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | -| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | -| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | - -### Stellar for smart contract developers - -| **Contract Devs** | | | -| :-: | --- | --- | -| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | -| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks here | -| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them here | -| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | -| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | -| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | -| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | - -| **Contract Devs (optional pages)** | | | +### **Stellar for asset issuers** + +
+ Stellar assets| | | | | :-: | :-- | :-- | | **Learn** | + [Asset and token introduction](https://developers.stellar.org/docs/tokens) | + Learn about the difference between assets issued on Stellar and custom smart + contract tokens | | **Learn** | [Data availability + overview](https://developers.stellar.org/docs/data) | Learn about the + different mechanisms for data availability on Stellar | | **Guide** | + [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | + Issue an asset on the Stellar network in a single transaction | | **Learn** | + [Asset design + considerations](https://developers.stellar.org/docs/tokens/control-asset-access) + | Learn about certain considerations (e.g., flags, asset naming, etc.) that + are important when issuing an asset | | **Learn** | [Stellar Asset Contract + (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | + Learn about interacting with assets issued on Stellar in smart contracts | | + **Guide** | [Deploy an + SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | + Deploy a Stellar Asset Contract with the Stellar CLI | +
+ +
+ Custom tokens| | | | | :-: | :-- | :-- | | **Learn** | + [Asset and token introduction](https://developers.stellar.org/docs/tokens) | + Learn about the difference between assets issued on Stellar and custom smart + contract tokens | | **Learn** | [Data availability + overview](https://developers.stellar.org/docs/data) | Learn about the + different mechanisms for data availability on Stellar | | **Learn** | [Token + interface + (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn + about the common interface for smart contract tokens on Stellar | | + **Example** | [Token example + contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) + | Demonstrates how to write a token contract that implements the Token + Interface | | **Guide** | [Manage + contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) + | Use the Stellar CLI to manage smart contracts | | **Tool** | [Stellar + CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line + interface to Stellar smart contracts | | **Tool** | [Rust + SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing + programs for Stellar smart contracts | +
+ +### **Stellar for smart contract developers** + +
+ Contract developers essential pages| | | | | :-: | --- | + --- | | **Learn** | [Stellar smart contracts + overview](https://developers.stellar.org/docs/build/smart-contracts/overview) + | Learn the essentials about writing smart contracts on Stellar | | **Learn** + | [Migrating from EVM + networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not + an EVM network, learn about how Stellar differs from EVM networks here | | + **Learn** | [Storage + types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) + | There are three different storage types for smart contract data, learn about + them here | | **Guide** | [Getting started + guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) + | The go-to guide for getting setup to write smart contracts on Stellar | | + **Guide** | [Example + contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) + | These contracts are good starting points for understanding best practices + and writing your own contracts on Stellar | | **Guide** | [General contract + guides](https://developers.stellar.org/docs/build/guides/conventions) | + Various guides that highlight the norms seen in contract development | | + **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) + | The command line interface to Stellar smart contracts | | **Tool** | [Rust + SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing + programs for Stellar smart contracts | +
+ +
+ Contract developers optional pages + +| | | | | :-: | --- | --- | | **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset. | | **Guide** | [Upgrading contracts](https://developers.stellar.org/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | -### Stellar for ramps (anchors) - -| **Ramps** | | | -| :-: | --- | --- | -| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | -| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences here | -| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | -| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | -| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | -| **Tool** | Anchor test suite | | - -### Stellar for applications - -| **Traditional wallets** | | | +
+ +### **Stellar for ramps (anchors)** + +
+ Ramps| | | | | :-: | --- | --- | | **Learn** | [Anchor + overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | + Stellar ramps are called "anchors", learn about them in this overview section + | | **Learn** | [SEP-6 and + SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) + | You can set up an anchor using SEP-6 or SEP-24, learn about the differences + here | | **Tutorial** | [Anchor + Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up + an anchor using the SDF-maintained Anchor Platform | | **Data** | [Use a + third-party Horizon + provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) + | We recommend anchors use a third-party Horizon provider, but they can also + set up their own | | **Tool** | [Demo + wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) + | An application for interactively testing anchor services. Lets financial + application developers test their integrations and learn how Stellar ecosystem + protocols (SEPs) work | | **Tool** | Anchor test suite | | +
+ +### **Stellar for applications** + +
+ Traditional wallets + +| | | | | :-: | --- | --- | | **Learn** | [Application design considerations](https://developers.stellar.org/docs/build/apps/application-design-considerations) | Various concepts to consider when building a wallet, such as custody models, security, and more | | **Learn** | [Fees](https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee) | Learn about how fees work on the Stellar network and decide how you'd like to handle user fees | @@ -78,7 +135,12 @@ There's much more you can do with the Stellar network than what's listed below! | **Tutorial** | [Wallet SDK](https://developers.stellar.org/docs/category/build-a-wallet-with-the-wallet-sdk) | Learn to build a wallet with the Wallet SDK in Kotlin, Flutter, or TypeScript | | **Data** | [Horizon introduction](https://developers.stellar.org/docs/data/horizon) | Access network data using the Horizon REST API | -| **Decentralized applications** | _Start by viewing the smart contract wayfinding section_ | | +
+ +
+ Decentralized applications (start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers)) + +| | | | | :-: | --- | --- | | **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | | **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | @@ -87,28 +149,45 @@ There's much more you can do with the Stellar network than what's listed below! | **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | | **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC | -| **Exchanges** | | | +
+ +
+ Exchanges + +| | | | | :-: | --- | --- | | **Tools** | [SDKs](https://developers.stellar.org/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | | **Data** | [Run your own RPC](https://developers.stellar.org/docs/data/rpc/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | | **Data** | [Run your own Horizon](https://developers.stellar.org/docs/data/horizon/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | -### Stellar for infrastructure providers +
+ +### **Stellar for infrastructure providers** + +
+ Horizon -| **Horizon** | | | +| | | | | :-: | --- | --- | | **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | | **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | | **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | -| **RPC** | | | +
+ +
+ RPC + +| | | | | :-: | --- | --- | | **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | | **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | | **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the RPC setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | +
+ ## Navigating the docs #### [Build](/docs/build) From e7435a6dc724c2462442f061d89ddfd262e01086 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Mon, 28 Oct 2024 14:45:05 -0600 Subject: [PATCH 08/40] fix formatting --- src/pages/index.mdx | 148 +++++++++++++++++--------------------------- 1 file changed, 56 insertions(+), 92 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index f108d2564..dff411dd2 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -8,7 +8,7 @@ The developer docs will teach you how to build applications, issue and use token If you can’t find answers to your questions in the docs, search for your answer or ask questions in our [Stellar Developer Discord](https://discord.gg/stellardev) or [Stack Exchange](https://stellar.stackexchange.com/). -## Stellar wayfinding based on audience type +## Stellar guidance based on audience type :::note @@ -16,76 +16,53 @@ There's much more you can do with the Stellar network than what's listed below! ::: -### **Stellar for asset issuers** +### **Asset issuers**
- Stellar assets| | | | | :-: | :-- | :-- | | **Learn** | - [Asset and token introduction](https://developers.stellar.org/docs/tokens) | - Learn about the difference between assets issued on Stellar and custom smart - contract tokens | | **Learn** | [Data availability - overview](https://developers.stellar.org/docs/data) | Learn about the - different mechanisms for data availability on Stellar | | **Guide** | - [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | - Issue an asset on the Stellar network in a single transaction | | **Learn** | - [Asset design - considerations](https://developers.stellar.org/docs/tokens/control-asset-access) - | Learn about certain considerations (e.g., flags, asset naming, etc.) that - are important when issuing an asset | | **Learn** | [Stellar Asset Contract - (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | - Learn about interacting with assets issued on Stellar in smart contracts | | - **Guide** | [Deploy an - SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | - Deploy a Stellar Asset Contract with the Stellar CLI | + Stellar assets + +| | | | +| :-: | :-- | :-- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | +| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | +| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | +| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | +
- Custom tokens| | | | | :-: | :-- | :-- | | **Learn** | - [Asset and token introduction](https://developers.stellar.org/docs/tokens) | - Learn about the difference between assets issued on Stellar and custom smart - contract tokens | | **Learn** | [Data availability - overview](https://developers.stellar.org/docs/data) | Learn about the - different mechanisms for data availability on Stellar | | **Learn** | [Token - interface - (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn - about the common interface for smart contract tokens on Stellar | | - **Example** | [Token example - contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) - | Demonstrates how to write a token contract that implements the Token - Interface | | **Guide** | [Manage - contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) - | Use the Stellar CLI to manage smart contracts | | **Tool** | [Stellar - CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line - interface to Stellar smart contracts | | **Tool** | [Rust - SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing - programs for Stellar smart contracts | + Custom smart contract tokens + +| | | | +| :-: | :-- | :-- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | +| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | +| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | +
-### **Stellar for smart contract developers** +### **Smart contract developers**
- Contract developers essential pages| | | | | :-: | --- | - --- | | **Learn** | [Stellar smart contracts - overview](https://developers.stellar.org/docs/build/smart-contracts/overview) - | Learn the essentials about writing smart contracts on Stellar | | **Learn** - | [Migrating from EVM - networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not - an EVM network, learn about how Stellar differs from EVM networks here | | - **Learn** | [Storage - types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) - | There are three different storage types for smart contract data, learn about - them here | | **Guide** | [Getting started - guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) - | The go-to guide for getting setup to write smart contracts on Stellar | | - **Guide** | [Example - contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) - | These contracts are good starting points for understanding best practices - and writing your own contracts on Stellar | | **Guide** | [General contract - guides](https://developers.stellar.org/docs/build/guides/conventions) | - Various guides that highlight the norms seen in contract development | | - **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) - | The command line interface to Stellar smart contracts | | **Tool** | [Rust - SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing - programs for Stellar smart contracts | + Contract developers essential pages + +| | | | +| :-: | --- | --- | +| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | +| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks here | +| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | +| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | +| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | +| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | +
@@ -93,34 +70,28 @@ There's much more you can do with the Stellar network than what's listed below! | | | | | :-: | --- | --- | -| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset. | +| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | | **Guide** | [Upgrading contracts](https://developers.stellar.org/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address |
-### **Stellar for ramps (anchors)** +### **Ramps (anchors)**
- Ramps| | | | | :-: | --- | --- | | **Learn** | [Anchor - overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | - Stellar ramps are called "anchors", learn about them in this overview section - | | **Learn** | [SEP-6 and - SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) - | You can set up an anchor using SEP-6 or SEP-24, learn about the differences - here | | **Tutorial** | [Anchor - Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up - an anchor using the SDF-maintained Anchor Platform | | **Data** | [Use a - third-party Horizon - provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) - | We recommend anchors use a third-party Horizon provider, but they can also - set up their own | | **Tool** | [Demo - wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) - | An application for interactively testing anchor services. Lets financial - application developers test their integrations and learn how Stellar ecosystem - protocols (SEPs) work | | **Tool** | Anchor test suite | | + Ramps + +| | | | +| :-: | --- | --- | +| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | +| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | +| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | +| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | +| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | +| **Tool** | Anchor test suite | | +
-### **Stellar for applications** +### **Applications**
Traditional wallets @@ -138,16 +109,9 @@ There's much more you can do with the Stellar network than what's listed below!
- Decentralized applications (start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers)) + Decentralized applications -| | | | -| :-: | --- | --- | -| **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | -| **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | -| **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | -| **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | -| **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | -| **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC | +Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) | | | | | :-: | --- | --- | | **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | | **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | | **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | | **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | | **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | | **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC |
@@ -162,7 +126,7 @@ There's much more you can do with the Stellar network than what's listed below! -### **Stellar for infrastructure providers** +### **Infrastructure providers**
Horizon From d296c68578a390487ee90d15c9010ceb29cfbd8c Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Mon, 28 Oct 2024 15:19:01 -0600 Subject: [PATCH 09/40] Various edits --- src/pages/index.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index dff411dd2..0c6ce2bc5 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -128,6 +128,8 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont ### **Infrastructure providers** +Set up Stellar network infrastructure. +
Horizon @@ -137,6 +139,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | | **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | | **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | +| **Tools** | [Ecosystem providers](https://developers.stellar.org/docs/data/horizon/horizon-providers) | Create a PR in the docs to list your available Horizon service on this page |
@@ -149,6 +152,25 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont | **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | | **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | | **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the RPC setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | +| **Tools** | [Ecosystem providers](https://developers.stellar.org/docs/data/rpc/rpc-providers) | Create a PR in the docs to list your available RPC service on this page | + +
+ +### **Analytics** + +Perform analysis on network data. + +
+ Hubble + +| | | | +| :-: | --- | --- | +| **Learn** | [Connecting to Hubble](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/connecting.mdx) | Connect to Hubble using one of three methods: BigQuery UI, BigQuery SDK, or Looker Studio | +| **Learn** | [Data catalog](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/data-catalog) | insert text | +| **Tutorial** | [Admin guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | +| **Tutorial** | [Analyst guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | +| **Example** | [End-to-end example](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/end-to-end-analysis-example.mdx) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | +| **Tool** | [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that make a complete historical record of Pubnet Stellar network data available |
From faf216c7aacd605a2e125d46704e22754717e85e Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:07:19 -0600 Subject: [PATCH 10/40] fix dapp section --- src/pages/index.mdx | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 0c6ce2bc5..747138a98 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -55,7 +55,7 @@ There's much more you can do with the Stellar network than what's listed below! | | | | | :-: | --- | --- | | **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | -| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks here | +| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | | **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | | **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | | **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | @@ -111,7 +111,16 @@ There's much more you can do with the Stellar network than what's listed below!
Decentralized applications -Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) | | | | | :-: | --- | --- | | **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | | **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | | **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | | **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | | **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | | **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC | +Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) + +| | | | +| :-: | --- | --- | +| **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | +| **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | +| **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | +| **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | +| **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | +| **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC |
From 89d3342bf2b41c228e228bcb1a17266303f8c10b Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:16:52 -0600 Subject: [PATCH 11/40] update Hubble language --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 747138a98..eb59be194 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -179,7 +179,7 @@ Perform analysis on network data. | **Tutorial** | [Admin guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | | **Tutorial** | [Analyst guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | | **Example** | [End-to-end example](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/end-to-end-analysis-example.mdx) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | -| **Tool** | [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that make a complete historical record of Pubnet Stellar network data available | +| **Tool** | [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | From 71449c95a5b80568e9a8644dca76a92a09ceb61b Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:39:32 -0600 Subject: [PATCH 12/40] update anchor tools --- docs/tools/developer-tools/anchor-tools.mdx | 4 ++-- src/pages/index.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tools/developer-tools/anchor-tools.mdx b/docs/tools/developer-tools/anchor-tools.mdx index 9df1d8830..533c3f417 100644 --- a/docs/tools/developer-tools/anchor-tools.mdx +++ b/docs/tools/developer-tools/anchor-tools.mdx @@ -15,6 +15,6 @@ View all anchors on Stellar, their currencies, and where they operate. An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work; use the demo wallet to test Regulated Assets (SEP-8), Hosted Deposit and Withdrawal (SEP-24), and Cross-Border Payments (SEP-31) with any home domain that has a Stellar Info File (also known as SEP-1, or a stellar.toml file). -### [Polaris](https://django-polaris.readthedocs.io/en/stable/) +### [Anchor Test Suite](https://anchor-tests.stellar.org/) -An extendable django app that makes it easy for anchors to facilitate cross-border payments and enable deposits and withdrawals; run a web server supporting any combination of SEP-1, 6, 10, 12, and 24. +A test suite for validating SEP6, SEP24, SEP31 transfer servers. diff --git a/src/pages/index.mdx b/src/pages/index.mdx index eb59be194..a25962fef 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -87,7 +87,7 @@ There's much more you can do with the Stellar network than what's listed below! | **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | | **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | | **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | -| **Tool** | Anchor test suite | | +| **Tool** | [Anchor test suite](https://anchor-tests.stellar.org/) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | From 42e086319590c3b97d4110f889498fd74faa78ea Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Tue, 29 Oct 2024 10:51:13 -0600 Subject: [PATCH 13/40] quick link nit --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index a25962fef..0fc67b7cd 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -87,7 +87,7 @@ There's much more you can do with the Stellar network than what's listed below! | **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | | **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | | **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | -| **Tool** | [Anchor test suite](https://anchor-tests.stellar.org/) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | +| **Tool** | [Anchor test suite](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#anchor-test-suite) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | From 5c97e7d5e71e3d7070fb8677b0edff726333b0c5 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:46:49 -0600 Subject: [PATCH 14/40] update descriptions --- src/pages/index.mdx | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 0fc67b7cd..fd51c444e 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -12,12 +12,14 @@ If you can’t find answers to your questions in the docs, search for your answe :::note -There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs to find necessary conceptual information, tutorials, data availability recommendations, and more based on what you're trying to accomplish. +There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs to find necessary conceptual information, tutorials, data availability recommendations, and more based on your use case. ::: ### **Asset issuers** +Issue an asset on the Stellar network or create a custom smart contract token. +
Stellar assets @@ -49,6 +51,8 @@ There's much more you can do with the Stellar network than what's listed below! ### **Smart contract developers** +Write, test, deploy, and interact with smart contracts on the Stellar network. +
Contract developers essential pages @@ -77,6 +81,8 @@ There's much more you can do with the Stellar network than what's listed below! ### **Ramps (anchors)** +Set up an on/off-ramp (also known as an anchor) using the SDF-maintained Anchor Platform tool. +
Ramps @@ -93,6 +99,8 @@ There's much more you can do with the Stellar network than what's listed below! ### **Applications** +For application builders or exchanges that want to list Stellar assets. +
Traditional wallets @@ -129,6 +137,8 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont | | | | | :-: | --- | --- | +| **Learn** | [List of operations](https://developers.stellar.org/docs/learn/fundamentals/transactions/list-of-operations) | Learn how operations function on the Stellar network, notably `CreateAccount`, `Payment`, and `ChangeTrust` | +| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | | **Tools** | [SDKs](https://developers.stellar.org/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | | **Data** | [Run your own RPC](https://developers.stellar.org/docs/data/rpc/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | | **Data** | [Run your own Horizon](https://developers.stellar.org/docs/data/horizon/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | @@ -137,7 +147,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont ### **Infrastructure providers** -Set up Stellar network infrastructure. +Set up Stellar network infrastructure to use yourself or list as a third-party service for others.
Horizon @@ -167,7 +177,7 @@ Set up Stellar network infrastructure. ### **Analytics** -Perform analysis on network data. +Perform analysis on Stellar network data.
Hubble From 16ca5dbd598f009ca47a8bf9da80f7a26d70b84c Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Wed, 30 Oct 2024 16:11:23 -0600 Subject: [PATCH 15/40] Reformatting x2 --- src/components/WayfindingBoxes/index.js | 48 +++--- src/pages/index.mdx | 211 ++++++++++-------------- 2 files changed, 111 insertions(+), 148 deletions(-) diff --git a/src/components/WayfindingBoxes/index.js b/src/components/WayfindingBoxes/index.js index e814a1191..1c6f54944 100644 --- a/src/components/WayfindingBoxes/index.js +++ b/src/components/WayfindingBoxes/index.js @@ -6,93 +6,93 @@ import styles from './styles.module.css'; const WayfindingWays = [ { - title: 'Stellar 101', + title: 'Asset Issuers', image: require('@site/static/icons/stellar-101.png').default, description: ( <> - Learn about the core concepts of Stellar in this educational section. + Issue an asset on the Stellar network or create a custom smart contract token. ), link: ( - Dive In + to="#asset-issuers"> + Issue an asset ), }, { - title: 'Write a Smart Contract', + title: 'Smart Contract Developers', image: require('@site/static/icons/contract.png').default, description: ( <> - Get set up and write your first smart contract on the Stellar network. + Write, test, deploy, and interact with smart contracts on the Stellar network. ), // temporarily set this to /docs/soroban until "smart contracts" section is done link: ( - Get Started + to="#smart-contract-developers"> + Write a smart contract ), }, { - title: 'Issue an Asset', + title: 'Ramps (anchors)', image: require('@site/static/icons/issue-assets.png').default, description: ( <> - Issuing assets on Stellar is easy. Learn how in this tutorial. + Set up an on/off-ramp (also known as an anchor) using the SDF-maintained Anchor Platform tool. ), link: ( - Issue Asset + to="#ramps-anchors"> + Set up an anchor ), }, { - title: 'Build an Application', + title: 'Applications', image: require('@site/static/icons/build-applications.png').default, description: ( <> - Build an application on Stellar using the Wallet SDK or JS SDK. + For application builders or exchanges that want to list Stellar assets. ), link: ( - Get Building + to="#applications"> + Build an app ), }, { - title: 'Developer Tools', + title: 'Infrastructure Providers', image: require('@site/static/icons/dev-tools.png').default, description: ( <> - Stellar has a myriad of community and SDF-maintained tools. Check them out! + Set up Stellar network infrastructure to use yourself or list as a third-party service for others. ), link: ( - See Tools + to="#infrastructure-providers"> + Set up infrastructure ), }, { - title: 'Access Data', + title: 'Analytics', image: require('@site/static/icons/access-data.png').default, description: ( <> - The RPC, Hubble, and Horizon offer all the data capabilities you could possibly need. + Perform analysis on Stellar network data. ), link: ( - Get the Goods + to="#analytics"> + Access Stellar network data ), }, diff --git a/src/pages/index.mdx b/src/pages/index.mdx index fd51c444e..91faa3b64 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -1,3 +1,7 @@ +--- +hide_table_of_contents: true +--- + import WayfindingBoxes from "@site/src/components/WayfindingBoxes"; # Welcome to Stellar Developer Docs @@ -6,100 +10,111 @@ Stellar is a layer-1 open-source, decentralized, peer-to-peer blockchain network The developer docs will teach you how to build applications, issue and use tokens, write smart contracts, set up on and off-ramps, set up a validator node, and more. -If you can’t find answers to your questions in the docs, search for your answer or ask questions in our [Stellar Developer Discord](https://discord.gg/stellardev) or [Stack Exchange](https://stellar.stackexchange.com/). +## Stellar for... -## Stellar guidance based on audience type + -:::note +## Navigating the docs -There's much more you can do with the Stellar network than what's listed below! These pathfinding guides are meant to give you an idea of how to get started navigating the docs to find necessary conceptual information, tutorials, data availability recommendations, and more based on your use case. +#### [Build](/docs/build) -::: +Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. -### **Asset issuers** +#### [Learn](/docs/learn/fundamentals) -Issue an asset on the Stellar network or create a custom smart contract token. +Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. -
- Stellar assets - -| | | | -| :-: | :-- | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | -| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | -| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | -| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | +#### [Tokens](/docs/tokens) -
+Information on how to issue assets on the Stellar network and create custom smart contract tokens. -
- Custom smart contract tokens - -| | | | -| :-: | :-- | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | -| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | -| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | -| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | +#### [Data](/docs/data) -
+Discover various data availability options: RPC, Hubble, and Horizon. -### **Smart contract developers** +#### [Tools](/docs/tools) -Write, test, deploy, and interact with smart contracts on the Stellar network. +Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. -
- Contract developers essential pages - -| | | | -| :-: | --- | --- | -| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | -| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | -| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | -| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | -| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | -| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +#### [Networks](/docs/networks) + +Information about delpoyed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. + +#### [Validators](/docs/validators) + +Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. + +## Contribute to the docs and leave feedback + +Stellar’s Developer Documentation is open-source, and contributions to the docs are encouraged. You can file an issue or pull request to add new content, suggest revisions to existing content, submit suggestions, report bugs, and more in the [Stellar Docs GitHub Repo](https://github.com/stellar/stellar-docs). + +Also, feel free to leave any additional feedback by filing issues in the various other [Stellar repos](https://github.com/stellar). + +## Developer resources + +Interact with other Stellar developers, keep up with ecosystem standards and protocol upgrades, and learn about upcoming events. + +[**Stellar Developer Discord**](https://discord.gg/st7Mxd58BV) Ask questions and engage with other Stellar devs. + +[**Stellar Developers Google Group**](https://groups.google.com/g/stellar-dev) Discuss Core Advancement Proposals (CAPs) and Stellar Ecosystem Proposals (SEPs), talk about the development of Stellar Core and Horizon, and stay informed about important network upgrades. + +[**Stellar Stack Exchange**](https://stellar.stackexchange.com/) A question and answer site for Stellar developers; if you can’t find what you’re looking for in the docs, try searching the Stack Exchange to see if your question has been addressed. If it hasn't, feel free to ask! + +[**Developer Site**](https://stellar.org/developers) Get the latest news and insights about building on Stellar. + +## Stellar docs pathfinding + +### **Asset issuers** + +| Asset issuers | | | +| :-- | :-: | :-- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | +| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | +| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | +| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | + +| Custom smart contract tokens | | | +| :-- | :-: | :-- | +| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | +| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | +| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | +| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | | **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | -
+### **Smart contract developers** -
- Contract developers optional pages +| Essential resources | | | +| :-- | :-: | :-- | +| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | +| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | +| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | +| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | +| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | +| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | +| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | +| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | -| | | | -| :-: | --- | --- | +| Optional resources | | | +| :-- | :-: | --- | | **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | | **Guide** | [Upgrading contracts](https://developers.stellar.org/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | -
- ### **Ramps (anchors)** -Set up an on/off-ramp (also known as an anchor) using the SDF-maintained Anchor Platform tool. - -
- Ramps - -| | | | -| :-: | --- | --- | -| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | -| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | -| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | -| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | -| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | +| | | | +| :-- | :-: | --- | +| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | +| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | +| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | +| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | +| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | | **Tool** | [Anchor test suite](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#anchor-test-suite) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | -
- -### **Applications** - -For application builders or exchanges that want to list Stellar assets. +#### **Applications**
Traditional wallets @@ -145,9 +160,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
-### **Infrastructure providers** - -Set up Stellar network infrastructure to use yourself or list as a third-party service for others. +#### **Infrastructure providers**
Horizon @@ -175,9 +188,7 @@ Set up Stellar network infrastructure to use yourself or list as a third-party s
-### **Analytics** - -Perform analysis on Stellar network data. +#### **Analytics**
Hubble @@ -192,51 +203,3 @@ Perform analysis on Stellar network data. | **Tool** | [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network |
- -## Navigating the docs - -#### [Build](/docs/build) - -Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. - -#### [Learn](/docs/learn/fundamentals) - -Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. - -#### [Tokens](/docs/tokens) - -Information on how to issue assets on the Stellar network and create custom smart contract tokens. - -#### [Data](/docs/data) - -Discover various data availability options: RPC, Hubble, and Horizon. - -#### [Tools](/docs/tools) - -Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. - -#### [Networks](/docs/networks) - -Information about delpoyed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. - -#### [Validators](/docs/validators) - -Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. - -## Contribute to the docs and leave feedback - -Stellar’s Developer Documentation is open-source, and contributions to the docs are encouraged. You can file an issue or pull request to add new content, suggest revisions to existing content, submit suggestions, report bugs, and more in the [Stellar Docs GitHub Repo](https://github.com/stellar/stellar-docs). - -Also, feel free to leave any additional feedback by filing issues in the various other [Stellar repos](https://github.com/stellar). - -## Developer resources - -Interact with other Stellar developers, keep up with ecosystem standards and protocol upgrades, and learn about upcoming events. - -[**Stellar Developer Discord**](https://discord.gg/st7Mxd58BV) Ask questions and engage with other Stellar devs. - -[**Stellar Developers Google Group**](https://groups.google.com/g/stellar-dev) Discuss Core Advancement Proposals (CAPs) and Stellar Ecosystem Proposals (SEPs), talk about the development of Stellar Core and Horizon, and stay informed about important network upgrades. - -[**Stellar Stack Exchange**](https://stellar.stackexchange.com/) A question and answer site for Stellar developers; if you can’t find what you’re looking for in the docs, try searching the Stack Exchange to see if your question has been addressed. If it hasn't, feel free to ask! - -[**Developer Site**](https://stellar.org/developers) Get the latest news and insights about building on Stellar. From 50ef1d64bae979ad1935d57cdf4c49c8320fcf79 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Mon, 11 Nov 2024 11:50:32 -0700 Subject: [PATCH 16/40] lil fix to build --- src/pages/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 91faa3b64..dd6eb231a 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -68,7 +68,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | Asset issuers | | | | :-- | :-: | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Asset and token intro](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | | **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | | **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | | **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | @@ -77,7 +77,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | Custom smart contract tokens | | | | :-- | :-: | :-- | -| **Learn** | [Asset and token introduction](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | +| **Learn** | [Asset and token intro](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | | **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | | **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | | **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | From 2fc7509fa88e5f285088f9778a8bcb39967bfc1c Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Tue, 12 Nov 2024 09:22:12 -0600 Subject: [PATCH 17/40] trigger a new container build From ebe42abd06b000f68a40c1ec45ddfbb5baca8b15 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 12:32:43 -0600 Subject: [PATCH 18/40] freshen up display of wayfinding boxes --- .../WayfindingBoxes/{index.js => index.tsx} | 21 ++++++++++++------- .../WayfindingBoxes/styles.module.css | 11 ++++++++-- 2 files changed, 23 insertions(+), 9 deletions(-) rename src/components/WayfindingBoxes/{index.js => index.tsx} (92%) diff --git a/src/components/WayfindingBoxes/index.js b/src/components/WayfindingBoxes/index.tsx similarity index 92% rename from src/components/WayfindingBoxes/index.js rename to src/components/WayfindingBoxes/index.tsx index c8523646f..05d96390f 100644 --- a/src/components/WayfindingBoxes/index.js +++ b/src/components/WayfindingBoxes/index.tsx @@ -1,11 +1,18 @@ -import React from 'react'; +import React, { type ReactNode } from 'react'; import clsx from 'clsx'; import Heading from '@theme/Heading'; import Link from '@docusaurus/Link'; import styles from './styles.module.css'; import Translate, {translate} from '@docusaurus/Translate'; -const WayfindingWays = [ +type WayfindingItem = { + title: string; + description: ReactNode; + image: string; + link: ReactNode; +} + +const WayfindingWays: WayfindingItem[] = [ { title: translate({ message: 'Asset Issuers', @@ -155,13 +162,13 @@ const WayfindingWays = [ function Feature({image, title, description, link}) { return (
-
- -
-
+
+
+ +
{title}

{description}

-

+

); diff --git a/src/components/WayfindingBoxes/styles.module.css b/src/components/WayfindingBoxes/styles.module.css index ec49f70e9..95ab8b27b 100644 --- a/src/components/WayfindingBoxes/styles.module.css +++ b/src/components/WayfindingBoxes/styles.module.css @@ -6,10 +6,17 @@ } .boxIcon { - height: 175px !important; - width: 175px !important; + object-fit: cover; + max-width: 75%; + height: auto; + max-height: 75%; } .boxIconLink { + display: flex; + justify-content: center; + align-items: center; margin-bottom: var(--ifm-heading-margin-bottom); + width: 100%; + height: 250px; } From 095ae49efaf079c75743082aa9c87ffe6544f7c9 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 14:15:14 -0600 Subject: [PATCH 19/40] custom component for the "navigating the docs" section --- .../Homepage/NavigatingTheDocs/index.tsx | 161 ++++++++++++++++++ .../NavigatingTheDocs/styles.module.css | 5 + src/pages/index.mdx | 31 +--- 3 files changed, 169 insertions(+), 28 deletions(-) create mode 100644 src/components/Homepage/NavigatingTheDocs/index.tsx create mode 100644 src/components/Homepage/NavigatingTheDocs/styles.module.css diff --git a/src/components/Homepage/NavigatingTheDocs/index.tsx b/src/components/Homepage/NavigatingTheDocs/index.tsx new file mode 100644 index 000000000..f3161e175 --- /dev/null +++ b/src/components/Homepage/NavigatingTheDocs/index.tsx @@ -0,0 +1,161 @@ +import React, { type ReactNode } from 'react'; +import Heading from '@theme/Heading'; +import Link from '@docusaurus/Link'; +import Translate, { translate } from '@docusaurus/Translate'; +import clsx from 'clsx'; +import styles from './styles.module.css' + +type NavigatingDocsItem = { + title: string; + description: ReactNode; + link: ReactNode; +} + +const learnMoreLink = (target: string) => ( + + + Learn more + + +) + +const partitionBoxes = (boxesArray: NavigatingDocsItem[]): NavigatingDocsItem[][] => { + return boxesArray.reduce((acc, item, i, arr) => { + if (i % 2 === 0) { + acc.push(arr.slice(i, i + 2)) + } + return acc + }, []) +} + +const NavigatingDocsBoxes: NavigatingDocsItem[] = [ + { + title: translate({ + message: 'Build', + id: 'component.NavigatingTheDocs.Build.Title', + }), + description: ( + + Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. + + ), + link: learnMoreLink('/docs/build'), + }, + { + title: translate({ + message: 'Learn', + id: 'component.NavigatingTheDocs.Learn.Title', + }), + description: ( + + Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. + + ), + link: learnMoreLink('/docs/learn/fundamentals'), + }, + { + title: translate({ + message: 'Tokens', + id: 'component.NavigatingTheDocs.Tokens.Title', + }), + description: ( + + Information on how to issue assets on the Stellar network and create custom smart contract tokens. + + ), + link: learnMoreLink('/docs/tokens'), + }, + { + title: translate({ + message: 'Data', + id: 'component.NavigatingTheDocs.Data.Title', + }), + description: ( + + Discover various data availability options: RPC, Hubble, and Horizon. + + ), + link: learnMoreLink('/docs/data'), + }, + { + title: translate({ + message: 'Tools', + id: 'component.NavigatingTheDocs.Tools.Title', + }), + description: ( + + Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. + + ), + link: learnMoreLink('/docs/tools'), + }, + { + title: translate({ + message: 'Networks', + id: 'component.NavigatingTheDocs.Networks.Title', + }), + description: ( + + Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. + + ), + link: learnMoreLink('/docs/networks'), + }, + { + title: translate({ + message: 'Validators', + id: 'component.NavigatingTheDocs.Validators.Title', + }), + description: ( + + Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. + + ), + link: learnMoreLink('/docs/validators'), + }, +] + +function NavigatingDocsFeature({title, description, link}) { + return ( +
+
+ {title} +

{description}

+ +
+
+ ) +} + +export default function NavigatingTheDocs() { + const partitionedBoxes = partitionBoxes(NavigatingDocsBoxes) + return ( +
+
+ {partitionedBoxes.map((twoBoxes) => ( +
+ {twoBoxes.map((props, idx) => ( + + ))} +
+ ))} +
+
+ ) +} diff --git a/src/components/Homepage/NavigatingTheDocs/styles.module.css b/src/components/Homepage/NavigatingTheDocs/styles.module.css new file mode 100644 index 000000000..e1ab9b9ef --- /dev/null +++ b/src/components/Homepage/NavigatingTheDocs/styles.module.css @@ -0,0 +1,5 @@ +.NavigatingDocsFeature { + border-radius: var(--ifm-global-radius); + background-color: var(--ifm-background-surface-color); + height: 100%; +} diff --git a/src/pages/index.mdx b/src/pages/index.mdx index dd6eb231a..ae560527a 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -2,7 +2,8 @@ hide_table_of_contents: true --- -import WayfindingBoxes from "@site/src/components/WayfindingBoxes"; +import WayfindingBoxes from "@site/src/components/Homepage/WayfindingBoxes"; +import NavigatingTheDocs from "@site/src/components/Homepage/NavigatingTheDocs"; # Welcome to Stellar Developer Docs @@ -16,33 +17,7 @@ The developer docs will teach you how to build applications, issue and use token ## Navigating the docs -#### [Build](/docs/build) - -Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. - -#### [Learn](/docs/learn/fundamentals) - -Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. - -#### [Tokens](/docs/tokens) - -Information on how to issue assets on the Stellar network and create custom smart contract tokens. - -#### [Data](/docs/data) - -Discover various data availability options: RPC, Hubble, and Horizon. - -#### [Tools](/docs/tools) - -Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. - -#### [Networks](/docs/networks) - -Information about delpoyed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. - -#### [Validators](/docs/validators) - -Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. + ## Contribute to the docs and leave feedback From a8964263d4486fc319cae8fafa061a998fc10cb7 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 14:16:09 -0600 Subject: [PATCH 20/40] move wayfinding boxes component into homepage folder --- src/components/{ => Homepage}/WayfindingBoxes/index.tsx | 0 src/components/{ => Homepage}/WayfindingBoxes/styles.module.css | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename src/components/{ => Homepage}/WayfindingBoxes/index.tsx (100%) rename src/components/{ => Homepage}/WayfindingBoxes/styles.module.css (100%) diff --git a/src/components/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx similarity index 100% rename from src/components/WayfindingBoxes/index.tsx rename to src/components/Homepage/WayfindingBoxes/index.tsx diff --git a/src/components/WayfindingBoxes/styles.module.css b/src/components/Homepage/WayfindingBoxes/styles.module.css similarity index 100% rename from src/components/WayfindingBoxes/styles.module.css rename to src/components/Homepage/WayfindingBoxes/styles.module.css From 80a2432b7b3f54dea43fb1278ade3b7e27609e3d Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 14:28:44 -0600 Subject: [PATCH 21/40] use similar styles for wayfinding and navigating "boxes" --- src/components/Homepage/WayfindingBoxes/index.tsx | 6 +++--- src/components/Homepage/WayfindingBoxes/styles.module.css | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/components/Homepage/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx index 05d96390f..9b4ac93d9 100644 --- a/src/components/Homepage/WayfindingBoxes/index.tsx +++ b/src/components/Homepage/WayfindingBoxes/index.tsx @@ -159,12 +159,12 @@ const WayfindingWays: WayfindingItem[] = [ }, ]; -function Feature({image, title, description, link}) { +function WayfindingFeature({image, title, description, link}) { return (
- +
{title}

{description}

@@ -180,7 +180,7 @@ export default function WayfindingBoxes() {
{WayfindingWays.map((props, idx) => ( - + ))}
diff --git a/src/components/Homepage/WayfindingBoxes/styles.module.css b/src/components/Homepage/WayfindingBoxes/styles.module.css index 95ab8b27b..bee56f642 100644 --- a/src/components/Homepage/WayfindingBoxes/styles.module.css +++ b/src/components/Homepage/WayfindingBoxes/styles.module.css @@ -16,7 +16,9 @@ display: flex; justify-content: center; align-items: center; + border-radius: var(--ifm-global-radius); margin-bottom: var(--ifm-heading-margin-bottom); + background-color: var(--ifm-background-surface-color); width: 100%; height: 250px; } From 2a757e2a76af67557175d0616d3aa466c744b5c7 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 15:22:50 -0600 Subject: [PATCH 22/40] developer resources section --- .../Homepage/DeveloperResources/index.tsx | 145 ++++++++++++++++++ .../DeveloperResources/styles.module.css | 5 + .../Homepage/NavigatingTheDocs/index.tsx | 43 +++--- src/pages/index.mdx | 17 +- 4 files changed, 177 insertions(+), 33 deletions(-) create mode 100644 src/components/Homepage/DeveloperResources/index.tsx create mode 100644 src/components/Homepage/DeveloperResources/styles.module.css diff --git a/src/components/Homepage/DeveloperResources/index.tsx b/src/components/Homepage/DeveloperResources/index.tsx new file mode 100644 index 000000000..7556b1847 --- /dev/null +++ b/src/components/Homepage/DeveloperResources/index.tsx @@ -0,0 +1,145 @@ +import React, { type ReactNode } from 'react' +import Heading from '@theme/Heading'; +import Link from '@docusaurus/Link'; +import clsx from 'clsx'; +import { learnMoreLink, partitionBoxes, type NavigatingDocsItem as DeveloperResourcesItem } from '@site/src/components/Homepage/NavigatingTheDocs' +import Translate, { translate } from '@docusaurus/Translate' +import styles from './styles.module.css' + +const DeveloperResourcesBoxes: DeveloperResourcesItem[] = [ + { + title: translate({ + message: 'Stellar Developer Discord', + id: 'component.Homepage.DeveloperResources.Discord.Title', + }), + description: ( + + Ask questions and engage with other Stellar devs. + + ), + link: learnMoreLink('https://discord.gg/st7Mxd58BV'), + }, + { + title: translate({ + message: 'Developer Site', + id: 'component.Homepage.DeveloperResources.DeveloperSite.Title', + }), + description: ( + + Get the latest news and insights about building on Stellar. + + ), + link: learnMoreLink('https://stellar.org/developers'), + }, + { + title: translate({ + message: 'Stellar Stack Exchange', + id: 'component.Homepage.DeveloperResources.StackExchange.Title', + }), + description: ( + + A question and answer site for Stellar developers; if you can’t find what you’re looking for in the docs, try searching the Stack Exchange to see if your question has been addressed. If it hasn't, feel free to ask! + + ), + link: learnMoreLink('https://stellar.stackexchange.com/'), + }, + { + title: translate({ + message: 'Stellar Developers Google Group', + id: 'component.Homepage.DeveloperResources.GoogleGroup.Title', + }), + description: ( + + Discuss Core Advancement Proposals (CAPs) and Stellar Ecosystem Proposals (SEPs), talk about the development of Stellar Core and Horizon, and stay informed about important network upgrades. + + ), + link: learnMoreLink('https://groups.google.com/g/stellar-dev'), + }, +] + +function DeveloperResourcesFeature({title, description, link}) { + return ( +
+
+ {title} +

{description}

+ +
+
+ ) +} + +function DocsContribution() { + return ( + <> + Contribute to the docs and leave feedback +

+ + + Stellar Docs GitHub Repo + + + ) + }}> + {'Stellar’s Developer Documentation is open-source, and contributions to the docs are encouraged. You can file an issue or pull request to add new content, suggest revisions to existing content, submit suggestions, report bugs, and more in the {githubRepoLink}.'} + +

+

+ + + Stellar repos + + + ) + }}> + {'Also, feel free to leave any additional feedback by filing issues in the various other {githubOrgLink}.'} + +

+ + ) +} + +export default function DeveloperResources() { + const partitionedBoxes = partitionBoxes(DeveloperResourcesBoxes); + + return ( +
+
+ {partitionedBoxes.map((twoBoxes) => ( +
+ {twoBoxes.map((props, idx) => ( + + ))} +
+ ))} +
+
+
+ +
+
+
+
+
+ ) +} diff --git a/src/components/Homepage/DeveloperResources/styles.module.css b/src/components/Homepage/DeveloperResources/styles.module.css new file mode 100644 index 000000000..89cabcb2e --- /dev/null +++ b/src/components/Homepage/DeveloperResources/styles.module.css @@ -0,0 +1,5 @@ +.DeveloperResourcesFeature { + border-radius: var(--ifm-global-radius); + background-color: var(--ifm-background-surface-color); + height: 100%; +} diff --git a/src/components/Homepage/NavigatingTheDocs/index.tsx b/src/components/Homepage/NavigatingTheDocs/index.tsx index f3161e175..f350bed6f 100644 --- a/src/components/Homepage/NavigatingTheDocs/index.tsx +++ b/src/components/Homepage/NavigatingTheDocs/index.tsx @@ -5,23 +5,23 @@ import Translate, { translate } from '@docusaurus/Translate'; import clsx from 'clsx'; import styles from './styles.module.css' -type NavigatingDocsItem = { +export type NavigatingDocsItem = { title: string; description: ReactNode; link: ReactNode; } -const learnMoreLink = (target: string) => ( +export const learnMoreLink = (target: string) => ( Learn more ) -const partitionBoxes = (boxesArray: NavigatingDocsItem[]): NavigatingDocsItem[][] => { +export const partitionBoxes = (boxesArray: NavigatingDocsItem[]): NavigatingDocsItem[][] => { return boxesArray.reduce((acc, item, i, arr) => { if (i % 2 === 0) { acc.push(arr.slice(i, i + 2)) @@ -34,11 +34,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Build', - id: 'component.NavigatingTheDocs.Build.Title', + id: 'component.Homepage.NavigatingTheDocs.Build.Title', }), description: ( Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. @@ -48,11 +48,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Learn', - id: 'component.NavigatingTheDocs.Learn.Title', + id: 'component.Homepage.NavigatingTheDocs.Learn.Title', }), description: ( Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. @@ -62,11 +62,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Tokens', - id: 'component.NavigatingTheDocs.Tokens.Title', + id: 'component.Homepage.NavigatingTheDocs.Tokens.Title', }), description: ( Information on how to issue assets on the Stellar network and create custom smart contract tokens. @@ -76,11 +76,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Data', - id: 'component.NavigatingTheDocs.Data.Title', + id: 'component.Homepage.NavigatingTheDocs.Data.Title', }), description: ( Discover various data availability options: RPC, Hubble, and Horizon. @@ -90,11 +90,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Tools', - id: 'component.NavigatingTheDocs.Tools.Title', + id: 'component.Homepage.NavigatingTheDocs.Tools.Title', }), description: ( Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. @@ -104,11 +104,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Networks', - id: 'component.NavigatingTheDocs.Networks.Title', + id: 'component.Homepage.NavigatingTheDocs.Networks.Title', }), description: ( Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. @@ -118,11 +118,11 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ { title: translate({ message: 'Validators', - id: 'component.NavigatingTheDocs.Validators.Title', + id: 'component.Homepage.NavigatingTheDocs.Validators.Title', }), description: ( Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. @@ -145,14 +145,15 @@ function NavigatingDocsFeature({title, description, link}) { export default function NavigatingTheDocs() { const partitionedBoxes = partitionBoxes(NavigatingDocsBoxes) + return (
{partitionedBoxes.map((twoBoxes) => (
- {twoBoxes.map((props, idx) => ( - - ))} + {twoBoxes.map((props, idx) => ( + + ))}
))}
diff --git a/src/pages/index.mdx b/src/pages/index.mdx index ae560527a..0344b907b 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -4,6 +4,7 @@ hide_table_of_contents: true import WayfindingBoxes from "@site/src/components/Homepage/WayfindingBoxes"; import NavigatingTheDocs from "@site/src/components/Homepage/NavigatingTheDocs"; +import DeveloperResources from "@site/src/components/Homepage/DeveloperResources"; # Welcome to Stellar Developer Docs @@ -15,27 +16,19 @@ The developer docs will teach you how to build applications, issue and use token +
+ ## Navigating the docs -## Contribute to the docs and leave feedback - -Stellar’s Developer Documentation is open-source, and contributions to the docs are encouraged. You can file an issue or pull request to add new content, suggest revisions to existing content, submit suggestions, report bugs, and more in the [Stellar Docs GitHub Repo](https://github.com/stellar/stellar-docs). - -Also, feel free to leave any additional feedback by filing issues in the various other [Stellar repos](https://github.com/stellar). - ## Developer resources Interact with other Stellar developers, keep up with ecosystem standards and protocol upgrades, and learn about upcoming events. -[**Stellar Developer Discord**](https://discord.gg/st7Mxd58BV) Ask questions and engage with other Stellar devs. - -[**Stellar Developers Google Group**](https://groups.google.com/g/stellar-dev) Discuss Core Advancement Proposals (CAPs) and Stellar Ecosystem Proposals (SEPs), talk about the development of Stellar Core and Horizon, and stay informed about important network upgrades. - -[**Stellar Stack Exchange**](https://stellar.stackexchange.com/) A question and answer site for Stellar developers; if you can’t find what you’re looking for in the docs, try searching the Stack Exchange to see if your question has been addressed. If it hasn't, feel free to ask! + -[**Developer Site**](https://stellar.org/developers) Get the latest news and insights about building on Stellar. +
## Stellar docs pathfinding From eb8fdfaadd20bda672de790690fc03a53ef7d33e Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 15:24:49 -0600 Subject: [PATCH 23/40] improve some docs contribution translation stuff --- src/components/Homepage/DeveloperResources/index.tsx | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/components/Homepage/DeveloperResources/index.tsx b/src/components/Homepage/DeveloperResources/index.tsx index 7556b1847..cc525fadc 100644 --- a/src/components/Homepage/DeveloperResources/index.tsx +++ b/src/components/Homepage/DeveloperResources/index.tsx @@ -80,7 +80,12 @@ function DeveloperResourcesFeature({title, description, link}) { function DocsContribution() { return ( <> - Contribute to the docs and leave feedback + + + Contribute to the docs and leave feedback + +

From 86755d547aa59e118e68b3d41ef8b7e828476ad5 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Thu, 19 Dec 2024 15:48:10 -0700 Subject: [PATCH 24/40] some fiddling around --- .../Homepage/NavigatingTheDocs/index.tsx | 8 +++--- .../Homepage/WayfindingBoxes/index.tsx | 26 +++++++++---------- src/pages/index.mdx | 10 ++++--- 3 files changed, 23 insertions(+), 21 deletions(-) diff --git a/src/components/Homepage/NavigatingTheDocs/index.tsx b/src/components/Homepage/NavigatingTheDocs/index.tsx index f350bed6f..5ebfa8f17 100644 --- a/src/components/Homepage/NavigatingTheDocs/index.tsx +++ b/src/components/Homepage/NavigatingTheDocs/index.tsx @@ -16,7 +16,7 @@ export const learnMoreLink = (target: string) => ( - Learn more + Explore ) @@ -82,7 +82,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ - Discover various data availability options: RPC, Hubble, and Horizon. + Discover various data availability options: RPC, Hubble, Horizon, Galexie, and data indexers. ), link: learnMoreLink('/docs/data'), @@ -96,7 +96,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ - Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. + Learn about all the available tools for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. ), link: learnMoreLink('/docs/tools'), @@ -110,7 +110,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ - Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees. + Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, resource limitations, and fees. ), link: learnMoreLink('/docs/networks'), diff --git a/src/components/Homepage/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx index 9b4ac93d9..fdf825390 100644 --- a/src/components/Homepage/WayfindingBoxes/index.tsx +++ b/src/components/Homepage/WayfindingBoxes/index.tsx @@ -23,7 +23,7 @@ const WayfindingWays: WayfindingItem[] = [ - Issue an asset on the Stellar network or create a custom smart contract token. + Issue an asset or create a custom smart contract token. ), link: ( @@ -32,7 +32,7 @@ const WayfindingWays: WayfindingItem[] = [ - Issue an asset + Learn more ), @@ -47,7 +47,7 @@ const WayfindingWays: WayfindingItem[] = [ - Write, test, deploy, and interact with smart contracts on the Stellar network. + Write smart contracts on the Stellar network. ), link: ( @@ -56,14 +56,14 @@ const WayfindingWays: WayfindingItem[] = [ - Write a smart contract + Learn more ), }, { title: translate({ - message: 'Ramps (anchors)', + message: 'Ramps (Anchors)', id: 'components.WayfindingBoxes.RampsAnchors.Title' }), image: require('@site/static/icons/issue-assets.png').default, @@ -71,7 +71,7 @@ const WayfindingWays: WayfindingItem[] = [ - Set up an on/off-ramp (also known as an anchor) using the SDF-maintained Anchor Platform tool. + Learn about and set up an anchor. ), link: ( @@ -80,7 +80,7 @@ const WayfindingWays: WayfindingItem[] = [ - Set up an anchor + Learn more ), @@ -95,7 +95,7 @@ const WayfindingWays: WayfindingItem[] = [ - For application builders or exchanges that want to list Stellar assets. + Build a traditional wallet, dapp, or list Stellar assets on an exchange. ), link: ( @@ -104,7 +104,7 @@ const WayfindingWays: WayfindingItem[] = [ - Build an app + Learn more ), @@ -119,7 +119,7 @@ const WayfindingWays: WayfindingItem[] = [ - Set up Stellar network infrastructure to use yourself or list as a third-party service for others. + Set up a Horizon or RPC service. ), link: ( @@ -128,7 +128,7 @@ const WayfindingWays: WayfindingItem[] = [ - Set up infrastructure + Learn more ), @@ -143,7 +143,7 @@ const WayfindingWays: WayfindingItem[] = [ - Perform analysis on Stellar network data. + Use Hubble to perform analysis on Stellar network data. ), link: ( @@ -152,7 +152,7 @@ const WayfindingWays: WayfindingItem[] = [ - Access Stellar network data + Learn more ), diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 0344b907b..59ec6daa2 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -12,17 +12,19 @@ Stellar is a layer-1 open-source, decentralized, peer-to-peer blockchain network The developer docs will teach you how to build applications, issue and use tokens, write smart contracts, set up on and off-ramps, set up a validator node, and more. -## Stellar for... +## **Stellar for...**


-## Navigating the docs +## **Navigating the docs** + +What each main section of the developer docs contains. -## Developer resources +## **Developer resources** Interact with other Stellar developers, keep up with ecosystem standards and protocol upgrades, and learn about upcoming events. @@ -30,7 +32,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-## Stellar docs pathfinding +## **Stellar docs pathfinding** ### **Asset issuers** From cf0734438a4cde4baf7cfc50264dbc32f590932b Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 18:10:34 -0600 Subject: [PATCH 25/40] add a pathfinding table custom component --- .../PathfindingTable/PathfindingRow/index.tsx | 31 +++++++++++++++++++ .../PathfindingRow/styles.module.css | 13 ++++++++ .../Homepage/PathfindingTable/index.tsx | 23 ++++++++++++++ .../PathfindingTable/styles.module.css | 5 +++ 4 files changed, 72 insertions(+) create mode 100644 src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx create mode 100644 src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css create mode 100644 src/components/Homepage/PathfindingTable/index.tsx create mode 100644 src/components/Homepage/PathfindingTable/styles.module.css diff --git a/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx b/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx new file mode 100644 index 000000000..7258a7c70 --- /dev/null +++ b/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx @@ -0,0 +1,31 @@ +import React from "react"; +import styles from './styles.module.css' +import clsx from "clsx"; + +const BADGE_CATEGORIES: Record = { + Learn: 'warning', + Guide: 'primary', + Tool: 'success', + Example: 'info', + Tutorial: 'danger', + Data: 'secondary', +} + +export default function PathfindingRow({ row }) { + const [linkTd, descTd, badgeTd] = row.props.children + + const description = descTd.props.children + const badgeCategory = badgeTd.props.children + console.log('badgeCategory', badgeCategory) + return ( + + + +
+ {description} + {badgeCategory} +
+ + + ) +} diff --git a/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css b/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css new file mode 100644 index 000000000..e9e3ad5c4 --- /dev/null +++ b/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css @@ -0,0 +1,13 @@ +.LinkColumn { + width: 25%; +} + +.DescColumn { + width: 75% +} + +.DescColumnInner { + display: flex; + justify-content: space-between; + align-items: center; +} diff --git a/src/components/Homepage/PathfindingTable/index.tsx b/src/components/Homepage/PathfindingTable/index.tsx new file mode 100644 index 000000000..c35174ebe --- /dev/null +++ b/src/components/Homepage/PathfindingTable/index.tsx @@ -0,0 +1,23 @@ +import React from 'react'; +import PathfindingRow from './PathfindingRow'; +import styles from './styles.module.css' + +export default function PathfindingTable({ children }) { + return ( + React.Children.map(children, child => { + const [thead, tbody] = child.props.children + const rows = tbody.props.children + + return ( + + + + + + {React.Children.map(rows, row => )} + +
+ ) + }) + ) +} diff --git a/src/components/Homepage/PathfindingTable/styles.module.css b/src/components/Homepage/PathfindingTable/styles.module.css new file mode 100644 index 000000000..4e581360c --- /dev/null +++ b/src/components/Homepage/PathfindingTable/styles.module.css @@ -0,0 +1,5 @@ +.PathfindingTable { + border-radius: var(--ifm-global-radius); + display: table; + width: 100%; +} From 88ebdc2155cc30a1ed1dba4c5ece30587f56b0a2 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 19 Dec 2024 18:20:03 -0600 Subject: [PATCH 26/40] apply pathfinding tables to index page --- src/pages/index.mdx | 189 ++++++++++++++++++++++++++------------------ 1 file changed, 113 insertions(+), 76 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 0344b907b..612f0094a 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -5,6 +5,7 @@ hide_table_of_contents: true import WayfindingBoxes from "@site/src/components/Homepage/WayfindingBoxes"; import NavigatingTheDocs from "@site/src/components/Homepage/NavigatingTheDocs"; import DeveloperResources from "@site/src/components/Homepage/DeveloperResources"; +import PathfindingTable from "@site/src/components/Homepage/PathfindingTable"; # Welcome to Stellar Developer Docs @@ -32,70 +33,86 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ## Stellar docs pathfinding -### **Asset issuers** +### Asset issuers + + | Asset issuers | | | -| :-- | :-: | :-- | -| **Learn** | [Asset and token intro](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Learn** | [Asset design considerations](https://developers.stellar.org/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | -| **Learn** | [Stellar Asset Contract (SAC)](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | -| **Guide** | [Quickstart script](https://developers.stellar.org/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | -| **Guide** | [Deploy an SAC](https://developers.stellar.org/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | +| :-- | --- | --- | +| [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | +| [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | +| [Asset design considerations](/docs/tokens/control-asset-access) | Learn about certain considerations (e.g., flags, asset naming, etc.) that are important when issuing an asset | Learn | +| [Stellar Asset Contract (SAC)](/docs/tokens/stellar-asset-contract) | Learn about interacting with assets issued on Stellar in smart contracts | Learn | +| [Quickstart script](/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | Guide | +| [Deploy an SAC](/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | Guide | | Custom smart contract tokens | | | -| :-- | :-: | :-- | -| **Learn** | [Asset and token intro](https://developers.stellar.org/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | -| **Learn** | [Data availability overview](https://developers.stellar.org/docs/data) | Learn about the different mechanisms for data availability on Stellar | -| **Learn** | [Token interface (SEP-41)](https://developers.stellar.org/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | -| **Example** | [Token example contract](https://developers.stellar.org/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | -| **Guide** | [Manage contracts](https://developers.stellar.org/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | -| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | +| :-- | --- | --- | +| [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | +| [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | +| [Token interface (SEP-41)](/docs/tokens/token-interface) | Learn about the common interface for smart contract tokens on Stellar | Learn | +| [Token example contract](/docs/build/smart-contracts/example-contracts/tokens) | Demonstrates how to write a token contract that implements the Token Interface | Example | +| [Manage contracts](/docs/build/guides/cli/contract-lifecycle) | Use the Stellar CLI to manage smart contracts | Guide | +| [Stellar CLI](/docs/build/guides/cli) | The command line interface to Stellar smart contracts | Tool | +| [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | Tool | + + ### **Smart contract developers** + + | Essential resources | | | -| :-- | :-: | :-- | -| **Learn** | [Stellar smart contracts overview](https://developers.stellar.org/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | -| **Learn** | [Migrating from EVM networks](https://developers.stellar.org/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | -| **Learn** | [Storage types](https://developers.stellar.org/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | -| **Guide** | [Getting started guide](https://developers.stellar.org/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | -| **Guide** | [Example contracts](https://developers.stellar.org/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | -| **Guide** | [General contract guides](https://developers.stellar.org/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | -| **Tool** | [Stellar CLI](https://developers.stellar.org/docs/build/guides/cli) | The command line interface to Stellar smart contracts | -| **Tool** | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | +| :-- | --- | --- | +| [Stellar smart contracts overview](/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | Learn | +| [Migrating from EVM networks](/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | Learn | +| [Storage types](/docs/learn/encyclopedia/storage/state-archival#contract-data-type-descriptions) | There are three different storage types for smart contract data, learn about them in this section | Learn | +| [Getting started guide](/docs/build/smart-contracts/getting-started) | The go-to guide for getting setup to write smart contracts on Stellar | Guide | +| [Example contracts](/docs/build/smart-contracts/example-contracts) | These contracts are good starting points for understanding best practices and writing your own contracts on Stellar | Guide | +| [General contract guides](/docs/build/guides/conventions) | Various guides that highlight the norms seen in contract development | Guide | +| [Stellar CLI](/docs/build/guides/cli) | The command line interface to Stellar smart contracts | Tool | +| [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | Tool | | Optional resources | | | -| :-- | :-: | --- | -| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | -| **Guide** | [Upgrading contracts](https://developers.stellar.org/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | +| :-- | --- | --- | +| [Trustlines](/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | Learn | +| [Upgrading contracts](/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | Guide | + + ### **Ramps (anchors)** -| | | | -| :-- | :-: | --- | -| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | -| **Learn** | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | -| **Tutorial** | [Anchor Platform](https://developers.stellar.org/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | -| **Data** | [Use a third-party Horizon provider](https://developers.stellar.org/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | -| **Tool** | [Demo wallet](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | -| **Tool** | [Anchor test suite](https://developers.stellar.org/docs/tools/developer-tools/anchor-tools#anchor-test-suite) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | + + +| Ramps | | | +| :-- | --- | --- | +| [Anchor overview](/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | Learn | +| [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | Learn | +| [Anchor Platform](/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | Tutorial | +| [Use a third-party Horizon provider](/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | Data | +| [Demo wallet](/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | Tool | +| [Anchor test suite](/docs/tools/developer-tools/anchor-tools#anchor-test-suite) | A test suite for validating SEP6, SEP24, SEP31 transfer servers | Tool | + + #### **Applications**
Traditional wallets + + | | | | -| :-: | --- | --- | -| **Learn** | [Application design considerations](https://developers.stellar.org/docs/build/apps/application-design-considerations) | Various concepts to consider when building a wallet, such as custody models, security, and more | -| **Learn** | [Fees](https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee) | Learn about how fees work on the Stellar network and decide how you'd like to handle user fees | -| **Learn** | [Operations & transactions](https://developers.stellar.org/docs/learn/fundamentals/transactions) | Wallets build and submit transactions, learn about about how operations and transactions work here | -| **Learn** | [Signatures & multisig](https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig) | Signatures are authorization for transactions on the Stellar network, learn about them here | -| **Learn** | [Anchor overview](https://developers.stellar.org/docs/learn/fundamentals/anchors) | Wallets may want to connect to financial rails via anchors (on- and off-ramps), learn about them here | -| **Tutorial** | [Wallet SDK](https://developers.stellar.org/docs/category/build-a-wallet-with-the-wallet-sdk) | Learn to build a wallet with the Wallet SDK in Kotlin, Flutter, or TypeScript | -| **Data** | [Horizon introduction](https://developers.stellar.org/docs/data/horizon) | Access network data using the Horizon REST API | +| :-- | --- | --- | +| [Application design considerations](/docs/build/apps/application-design-considerations) | Various concepts to consider when building a wallet, such as custody models, security, and more | Learn | +| [Fees](/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee) | Learn about how fees work on the Stellar network and decide how you'd like to handle user fees | Learn | +| [Operations & transactions](/docs/learn/fundamentals/transactions) | Wallets build and submit transactions, learn about about how operations and transactions work here | Learn | +| [Signatures & multisig](/docs/learn/encyclopedia/security/signatures-multisig) | Signatures are authorization for transactions on the Stellar network, learn about them here | Learn | +| [Anchor overview](/docs/learn/fundamentals/anchors) | Wallets may want to connect to financial rails via anchors (on- and off-ramps), learn about them here | Learn | +| [Wallet SDK](/docs/category/build-a-wallet-with-the-wallet-sdk) | Learn to build a wallet with the Wallet SDK in Kotlin, Flutter, or TypeScript | Tutorial | +| [Horizon introduction](/docs/data/horizon) | Access network data using the Horizon REST API | Data | + +
@@ -104,27 +121,35 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) + + | | | | -| :-: | --- | --- | -| **Learn** | [Transaction simulation](https://developers.stellar.org/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | -| **Guide** | [Dapp frontend](https://developers.stellar.org/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | -| **Guides** | [Dapp how-to guides](https://developers.stellar.org/docs/build/guides/dapps) | Explore the various guides relating to dapp development | -| **Tool** | [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | -| **Data** | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | -| **Data** | [RPC introduction](https://developers.stellar.org/docs/data/rpc) | Access network data using the RPC | +| :-- | --- | --- | +| [Transaction simulation](/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | Learn | +| [Dapp frontend](/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | Guide | +| [Dapp how-to guides](/docs/build/guides/dapps) | Explore the various guides relating to dapp development | Guide | +| [Stellar Wallets Kit](https://stellarwalletskit.dev/) | A kit to handle all Stellar Wallets at once with a simple API and without caring about individual configurations for each one of them | Tool | +| [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | Data | +| [RPC introduction](/docs/data/rpc) | Access network data using the RPC | Data | + +
Exchanges + + | | | | -| :-: | --- | --- | -| **Learn** | [List of operations](https://developers.stellar.org/docs/learn/fundamentals/transactions/list-of-operations) | Learn how operations function on the Stellar network, notably `CreateAccount`, `Payment`, and `ChangeTrust` | -| **Learn** | [Trustlines](https://developers.stellar.org/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | -| **Tools** | [SDKs](https://developers.stellar.org/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | -| **Data** | [Run your own RPC](https://developers.stellar.org/docs/data/rpc/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | -| **Data** | [Run your own Horizon](https://developers.stellar.org/docs/data/horizon/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | +| :-- | --- | --- | +| [List of operations](/docs/learn/fundamentals/transactions/list-of-operations) | Learn how operations function on the Stellar network, notably `CreateAccount`, `Payment`, and `ChangeTrust` | Learn | +| [Trustlines](/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | Learn | +| [SDKs](/docs/tools/sdks) | Used to connect to Horizon or RPC, as well as construct and parse transactions | Tool | +| [Run your own RPC](/docs/data/rpc/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | Data | +| [Run your own Horizon](/docs/data/horizon/admin-guide) | Exchanges typically run their own RPC or Horizon to maintain greater control over data integrity, performance, and security | Data | + +
@@ -133,26 +158,34 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
Horizon + + | | | | -| :-: | --- | --- | -| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | -| **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | -| **Guide** | [API reference](https://developers.stellar.org/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | -| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | -| **Tools** | [Ecosystem providers](https://developers.stellar.org/docs/data/horizon/horizon-providers) | Create a PR in the docs to list your available Horizon service on this page | +| :-- | --- | --- | +| [Hardware requirements](/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | Learn | +| [Admin guide](/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | Tutorial | +| [API reference](/docs/data/horizon/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | Guide | +| [SDK library](/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | Tool | +| [Ecosystem providers](/docs/data/horizon/horizon-providers) | Create a PR in the docs to list your available Horizon service on this page | Tool | + +
RPC + + | | | | -| :-: | --- | --- | -| **Learn** | [Hardware requirements](https://developers.stellar.org/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | -| **Tutorial** | [Admin guide](https://developers.stellar.org/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | -| **Guide** | [API reference](https://developers.stellar.org/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | -| **Tools** | [SDK library](https://developers.stellar.org/docs/tools/sdks/library) | Use the various SDKs to simplify the RPC setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | -| **Tools** | [Ecosystem providers](https://developers.stellar.org/docs/data/rpc/rpc-providers) | Create a PR in the docs to list your available RPC service on this page | +| :-- | --- | --- | +| [Hardware requirements](/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | Learn | +| [Admin guide](/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | Tutorial | +| [API reference](/docs/data/rpc/api-reference) | Detailed documentation that provides information about the API endpoints, methods, parameters, and responses | Guide | +| [SDK library](/docs/tools/sdks/library) | Use the various SDKs to simplify the RPC setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | Tool | +| [Ecosystem providers](/docs/data/rpc/rpc-providers) | Create a PR in the docs to list your available RPC service on this page | Tool | + +
@@ -161,13 +194,17 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
Hubble + + | | | | -| :-: | --- | --- | -| **Learn** | [Connecting to Hubble](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/connecting.mdx) | Connect to Hubble using one of three methods: BigQuery UI, BigQuery SDK, or Looker Studio | -| **Learn** | [Data catalog](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/data-catalog) | insert text | -| **Tutorial** | [Admin guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | -| **Tutorial** | [Analyst guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | -| **Example** | [End-to-end example](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/end-to-end-analysis-example.mdx) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | -| **Tool** | [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | +| :-- | --- | --- | +| [Connecting to Hubble](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/connecting.mdx) | Connect to Hubble using one of three methods: BigQuery UI, BigQuery SDK, or Looker Studio | Learn | +| [Data catalog](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/data-catalog) | insert text | Learn | +| [Admin guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | Tutorial | +| [Analyst guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | Tutorial | +| [End-to-end example](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/end-to-end-analysis-example.mdx) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | Example | +| [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | Tool | + +
From bad9f0bde37aeb7c15036693a4532d0285162a2e Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Thu, 19 Dec 2024 19:20:07 -0700 Subject: [PATCH 27/40] include drop downs --- src/pages/index.mdx | 43 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 3497ff113..f2aa462e3 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -37,9 +37,12 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Asset issuers +
+ Asset issuers + -| Asset issuers | | | +| | | | | :-- | --- | --- | | [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | | [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | @@ -48,7 +51,16 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Quickstart script](/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | Guide | | [Deploy an SAC](/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | Guide | -| Custom smart contract tokens | | | + + +
+ +
+ Custom smart contract tokens + + + +| | | | | :-- | --- | --- | | [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | | [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | @@ -60,11 +72,16 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro +
+ ### **Smart contract developers** +
+ Essential resources + -| Essential resources | | | +| | | | | :-- | --- | --- | | [Stellar smart contracts overview](/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | Learn | | [Migrating from EVM networks](/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | Learn | @@ -75,18 +92,32 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Stellar CLI](/docs/build/guides/cli) | The command line interface to Stellar smart contracts | Tool | | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | Tool | -| Optional resources | | | + + +
+ +
+ Optional resources + + + +| | | | | :-- | --- | --- | | [Trustlines](/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | Learn | | [Upgrading contracts](/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | Guide | +
+ ### **Ramps (anchors)** +
+ Ramps + -| Ramps | | | +| | | | | :-- | --- | --- | | [Anchor overview](/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | Learn | | [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | Learn | @@ -97,6 +128,8 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro +
+ #### **Applications**
From 7b4cd337668ca1c95b5adf160e6b641a90898b14 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Thu, 19 Dec 2024 19:44:36 -0700 Subject: [PATCH 28/40] heading fixes --- src/pages/index.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index f2aa462e3..768bc22c0 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -74,7 +74,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-### **Smart contract developers** +### Smart contract developers
Essential resources @@ -110,7 +110,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-### **Ramps (anchors)** +### Ramps (anchors)
Ramps @@ -130,7 +130,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-#### **Applications** +### Applications
Traditional wallets @@ -188,7 +188,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
-#### **Infrastructure providers** +### Infrastructure providers
Horizon @@ -224,7 +224,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
-#### **Analytics** +### Analytics
Hubble From 18a564095e83ceeb389c45e9d04963ab9c2b95d7 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 20 Dec 2024 08:26:08 -0700 Subject: [PATCH 29/40] words --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 768bc22c0..d71d7a118 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -38,7 +38,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Asset issuers
- Asset issuers + Stellar assets From 4fca4d81f51ae496a1f0454fa25d6662f75703d4 Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 20 Dec 2024 08:43:03 -0700 Subject: [PATCH 30/40] fix link --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index d71d7a118..e181f3dfa 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -120,7 +120,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | | | | | :-- | --- | --- | | [Anchor overview](/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | Learn | -| [SEP-6 and SEP-24](http://developers.stellar.org/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | Learn | +| [SEP-6 and SEP-24](/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | Learn | | [Anchor Platform](/platforms/anchor-platform) | Set up an anchor using the SDF-maintained Anchor Platform | Tutorial | | [Use a third-party Horizon provider](/docs/data/horizon/horizon-providers) | We recommend anchors use a third-party Horizon provider, but they can also set up their own | Data | | [Demo wallet](/docs/tools/developer-tools/anchor-tools#demo-wallet) | An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work | Tool | From 972fee706abe498c7d34bbdbffe2b7308e13def5 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 10:35:42 -0600 Subject: [PATCH 31/40] fix poor contrast on wayfinding boxes --- src/components/Homepage/WayfindingBoxes/styles.module.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/Homepage/WayfindingBoxes/styles.module.css b/src/components/Homepage/WayfindingBoxes/styles.module.css index bee56f642..e0e49ea4b 100644 --- a/src/components/Homepage/WayfindingBoxes/styles.module.css +++ b/src/components/Homepage/WayfindingBoxes/styles.module.css @@ -18,7 +18,7 @@ align-items: center; border-radius: var(--ifm-global-radius); margin-bottom: var(--ifm-heading-margin-bottom); - background-color: var(--ifm-background-surface-color); + background-color: var(--ifm-color-secondary); width: 100%; height: 250px; } From 2bb70b2015a22c48e88d9334c653518340e7cb13 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 10:40:57 -0600 Subject: [PATCH 32/40] rename explore and learn more link functions --- .../Homepage/DeveloperResources/index.tsx | 10 +-- .../Homepage/NavigatingTheDocs/index.tsx | 20 ++--- .../Homepage/WayfindingBoxes/index.tsx | 80 +++++-------------- 3 files changed, 33 insertions(+), 77 deletions(-) diff --git a/src/components/Homepage/DeveloperResources/index.tsx b/src/components/Homepage/DeveloperResources/index.tsx index cc525fadc..8c5936c7f 100644 --- a/src/components/Homepage/DeveloperResources/index.tsx +++ b/src/components/Homepage/DeveloperResources/index.tsx @@ -2,7 +2,7 @@ import React, { type ReactNode } from 'react' import Heading from '@theme/Heading'; import Link from '@docusaurus/Link'; import clsx from 'clsx'; -import { learnMoreLink, partitionBoxes, type NavigatingDocsItem as DeveloperResourcesItem } from '@site/src/components/Homepage/NavigatingTheDocs' +import { exploreLink, partitionBoxes, type NavigatingDocsItem as DeveloperResourcesItem } from '@site/src/components/Homepage/NavigatingTheDocs' import Translate, { translate } from '@docusaurus/Translate' import styles from './styles.module.css' @@ -19,7 +19,7 @@ const DeveloperResourcesBoxes: DeveloperResourcesItem[] = [ Ask questions and engage with other Stellar devs. ), - link: learnMoreLink('https://discord.gg/st7Mxd58BV'), + link: exploreLink('https://discord.gg/st7Mxd58BV'), }, { title: translate({ @@ -33,7 +33,7 @@ const DeveloperResourcesBoxes: DeveloperResourcesItem[] = [ Get the latest news and insights about building on Stellar. ), - link: learnMoreLink('https://stellar.org/developers'), + link: exploreLink('https://stellar.org/developers'), }, { title: translate({ @@ -47,7 +47,7 @@ const DeveloperResourcesBoxes: DeveloperResourcesItem[] = [ A question and answer site for Stellar developers; if you can’t find what you’re looking for in the docs, try searching the Stack Exchange to see if your question has been addressed. If it hasn't, feel free to ask! ), - link: learnMoreLink('https://stellar.stackexchange.com/'), + link: exploreLink('https://stellar.stackexchange.com/'), }, { title: translate({ @@ -61,7 +61,7 @@ const DeveloperResourcesBoxes: DeveloperResourcesItem[] = [ Discuss Core Advancement Proposals (CAPs) and Stellar Ecosystem Proposals (SEPs), talk about the development of Stellar Core and Horizon, and stay informed about important network upgrades. ), - link: learnMoreLink('https://groups.google.com/g/stellar-dev'), + link: exploreLink('https://groups.google.com/g/stellar-dev'), }, ] diff --git a/src/components/Homepage/NavigatingTheDocs/index.tsx b/src/components/Homepage/NavigatingTheDocs/index.tsx index 5ebfa8f17..038828800 100644 --- a/src/components/Homepage/NavigatingTheDocs/index.tsx +++ b/src/components/Homepage/NavigatingTheDocs/index.tsx @@ -11,11 +11,11 @@ export type NavigatingDocsItem = { link: ReactNode; } -export const learnMoreLink = (target: string) => ( +export const exploreLink = (target: string) => ( + id='component.Homepage.ExploreButton.Text' + description='The text that will be displayed on the "Explore" buttons'> Explore @@ -43,7 +43,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more. ), - link: learnMoreLink('/docs/build'), + link: exploreLink('/docs/build'), }, { title: translate({ @@ -57,7 +57,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more. ), - link: learnMoreLink('/docs/learn/fundamentals'), + link: exploreLink('/docs/learn/fundamentals'), }, { title: translate({ @@ -71,7 +71,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Information on how to issue assets on the Stellar network and create custom smart contract tokens. ), - link: learnMoreLink('/docs/tokens'), + link: exploreLink('/docs/tokens'), }, { title: translate({ @@ -85,7 +85,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Discover various data availability options: RPC, Hubble, Horizon, Galexie, and data indexers. ), - link: learnMoreLink('/docs/data'), + link: exploreLink('/docs/data'), }, { title: translate({ @@ -99,7 +99,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Learn about all the available tools for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform. ), - link: learnMoreLink('/docs/tools'), + link: exploreLink('/docs/tools'), }, { title: translate({ @@ -113,7 +113,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Information about deployed networks (Mainnet, Testnet, and Futurenet), current software versions, resource limitations, and fees. ), - link: learnMoreLink('/docs/networks'), + link: exploreLink('/docs/networks'), }, { title: translate({ @@ -127,7 +127,7 @@ const NavigatingDocsBoxes: NavigatingDocsItem[] = [ Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network. ), - link: learnMoreLink('/docs/validators'), + link: exploreLink('/docs/validators'), }, ] diff --git a/src/components/Homepage/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx index fdf825390..9d81f65b3 100644 --- a/src/components/Homepage/WayfindingBoxes/index.tsx +++ b/src/components/Homepage/WayfindingBoxes/index.tsx @@ -12,6 +12,16 @@ type WayfindingItem = { link: ReactNode; } +export const learnMoreLink = (target: string) => ( + + + LearnMore + + +) + const WayfindingWays: WayfindingItem[] = [ { title: translate({ @@ -26,16 +36,7 @@ const WayfindingWays: WayfindingItem[] = [ Issue an asset or create a custom smart contract token. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#asset-issuers"), }, { title: translate({ @@ -50,16 +51,7 @@ const WayfindingWays: WayfindingItem[] = [ Write smart contracts on the Stellar network. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#smart-contract-developers"), }, { title: translate({ @@ -74,16 +66,7 @@ const WayfindingWays: WayfindingItem[] = [ Learn about and set up an anchor. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#ramps-anchors"), }, { title: translate({ @@ -95,19 +78,10 @@ const WayfindingWays: WayfindingItem[] = [ - Build a traditional wallet, dapp, or list Stellar assets on an exchange. + Build a traditional wallet, dapp, or list Stellar assets on an exchange. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#applications"), }, { title: translate({ @@ -119,19 +93,10 @@ const WayfindingWays: WayfindingItem[] = [ - Set up a Horizon or RPC service. + Set up a Horizon or RPC service. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#infrastructure-providers"), }, { title: translate({ @@ -146,16 +111,7 @@ const WayfindingWays: WayfindingItem[] = [ Use Hubble to perform analysis on Stellar network data. ), - link: ( - - - Learn more - - - ), + link: learnMoreLink("#analytics"), }, ]; From c53069d7c1ff90242a5e8e68fd95a6636572db2d Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 20 Dec 2024 09:54:08 -0700 Subject: [PATCH 33/40] give me some space --- src/components/Homepage/WayfindingBoxes/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/Homepage/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx index 9d81f65b3..83649ce62 100644 --- a/src/components/Homepage/WayfindingBoxes/index.tsx +++ b/src/components/Homepage/WayfindingBoxes/index.tsx @@ -17,7 +17,7 @@ export const learnMoreLink = (target: string) => ( - LearnMore + Learn More ) From c9558bd82a179ecdbcb78d46a7c092d0342daed3 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 11:46:46 -0600 Subject: [PATCH 34/40] implement design notes - padding and semibold --- .../Homepage/DeveloperResources/index.tsx | 28 +++++++++---------- .../Homepage/NavigatingTheDocs/index.tsx | 16 +++++------ .../Homepage/WayfindingBoxes/index.tsx | 22 ++++++--------- 3 files changed, 29 insertions(+), 37 deletions(-) diff --git a/src/components/Homepage/DeveloperResources/index.tsx b/src/components/Homepage/DeveloperResources/index.tsx index 8c5936c7f..b32d8b312 100644 --- a/src/components/Homepage/DeveloperResources/index.tsx +++ b/src/components/Homepage/DeveloperResources/index.tsx @@ -69,7 +69,7 @@ function DeveloperResourcesFeature({title, description, link}) { return (
- {title} + {title}

{description}

@@ -80,7 +80,7 @@ function DeveloperResourcesFeature({title, description, link}) { function DocsContribution() { return ( <> - + Contribute to the docs and leave feedback @@ -129,21 +129,19 @@ export default function DeveloperResources() { return (
-
- {partitionedBoxes.map((twoBoxes) => ( -
- {twoBoxes.map((props, idx) => ( - - ))} -
+ {partitionedBoxes.map((twoBoxes) => ( +
+ {twoBoxes.map((props, idx) => ( + ))} -
-
-
- -
-
+
+ ))} +
+
+
+
+
) diff --git a/src/components/Homepage/NavigatingTheDocs/index.tsx b/src/components/Homepage/NavigatingTheDocs/index.tsx index 038828800..6d33cdbeb 100644 --- a/src/components/Homepage/NavigatingTheDocs/index.tsx +++ b/src/components/Homepage/NavigatingTheDocs/index.tsx @@ -135,7 +135,7 @@ function NavigatingDocsFeature({title, description, link}) { return (
- {title} + {title}

{description}

@@ -148,15 +148,13 @@ export default function NavigatingTheDocs() { return (
-
- {partitionedBoxes.map((twoBoxes) => ( -
- {twoBoxes.map((props, idx) => ( - - ))} -
+ {partitionedBoxes.map((twoBoxes) => ( +
+ {twoBoxes.map((props, idx) => ( + ))} -
+
+ ))}
) } diff --git a/src/components/Homepage/WayfindingBoxes/index.tsx b/src/components/Homepage/WayfindingBoxes/index.tsx index 83649ce62..4a25f1de3 100644 --- a/src/components/Homepage/WayfindingBoxes/index.tsx +++ b/src/components/Homepage/WayfindingBoxes/index.tsx @@ -118,14 +118,12 @@ const WayfindingWays: WayfindingItem[] = [ function WayfindingFeature({image, title, description, link}) { return (
-
-
- -
- {title} -

{description}

-

+
+
+ {title} +

{description}

+

); } @@ -133,12 +131,10 @@ function WayfindingFeature({image, title, description, link}) { export default function WayfindingBoxes() { return (
-
-
- {WayfindingWays.map((props, idx) => ( - - ))} -
+
+ {WayfindingWays.map((props, idx) => ( + + ))}
); From ce8dbc80631122a2cbba50ce9d6f97e03211333b Mon Sep 17 00:00:00 2001 From: Bri <92327786+briwylde08@users.noreply.github.com> Date: Fri, 20 Dec 2024 10:55:08 -0700 Subject: [PATCH 35/40] expanded by default --- src/pages/index.mdx | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index e181f3dfa..332302e3d 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -37,7 +37,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Asset issuers -
+
Stellar assets @@ -55,7 +55,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-
+
Custom smart contract tokens @@ -76,7 +76,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Smart contract developers -
+
Essential resources @@ -96,7 +96,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-
+
Optional resources @@ -112,7 +112,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Ramps (anchors) -
+
Ramps @@ -132,7 +132,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Applications -
+
Traditional wallets @@ -151,7 +151,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro
-
+
Decentralized applications Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) @@ -171,7 +171,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
-
+
Exchanges @@ -190,7 +190,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont ### Infrastructure providers -
+
Horizon @@ -207,7 +207,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont
-
+
RPC @@ -226,7 +226,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont ### Analytics -
+
Hubble From c2bb26328eece58824b03f16fc7f5eeb008bc5ca Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 14:15:04 -0600 Subject: [PATCH 36/40] style tweaks for badge displays in tables --- .../Homepage/PathfindingTable/PathfindingRow/index.tsx | 4 ++-- .../PathfindingTable/PathfindingRow/styles.module.css | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx b/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx index 7258a7c70..8e6fab2bb 100644 --- a/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx +++ b/src/components/Homepage/PathfindingTable/PathfindingRow/index.tsx @@ -16,12 +16,12 @@ export default function PathfindingRow({ row }) { const description = descTd.props.children const badgeCategory = badgeTd.props.children - console.log('badgeCategory', badgeCategory) + return ( -
+
{description} {badgeCategory}
diff --git a/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css b/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css index e9e3ad5c4..fba997cec 100644 --- a/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css +++ b/src/components/Homepage/PathfindingTable/PathfindingRow/styles.module.css @@ -8,6 +8,12 @@ .DescColumnInner { display: flex; + flex-direction: row; justify-content: space-between; align-items: center; + + @media (max-width: 640px) { + flex-direction: column; + align-items: start; + } } From 331befcb6a9bdfc97ab54bf120576f873284a498 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 14:30:09 -0600 Subject: [PATCH 37/40] add a check to ensure only tables are rendered as tables --- .../Homepage/PathfindingTable/index.tsx | 28 +++++++++++-------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/src/components/Homepage/PathfindingTable/index.tsx b/src/components/Homepage/PathfindingTable/index.tsx index c35174ebe..85a8944e4 100644 --- a/src/components/Homepage/PathfindingTable/index.tsx +++ b/src/components/Homepage/PathfindingTable/index.tsx @@ -5,19 +5,23 @@ import styles from './styles.module.css' export default function PathfindingTable({ children }) { return ( React.Children.map(children, child => { - const [thead, tbody] = child.props.children - const rows = tbody.props.children + if (child.type === 'table') { + const [thead, tbody] = child.props.children + const rows = tbody.props.children - return ( - - - - - - {React.Children.map(rows, row => )} - -
- ) + return ( + + + + + + {React.Children.map(rows, row => )} + +
+ ) + } else { + return child + } }) ) } From a8df995b6edd2d15605e4b5c120d132af84125d4 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 14:30:46 -0600 Subject: [PATCH 38/40] remove expandable details elements from homepage --- src/pages/index.mdx | 112 +++++++------------------------------------- 1 file changed, 18 insertions(+), 94 deletions(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 332302e3d..d322b84ac 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -37,12 +37,9 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro ### Asset issuers -
- Stellar assets - -| | | | +| Stellar Assets | | | | :-- | --- | --- | | [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | | [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | @@ -51,16 +48,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Quickstart script](/docs/tokens/quickstart) | Issue an asset on the Stellar network in a single transaction | Guide | | [Deploy an SAC](/docs/tokens/stellar-asset-contract) | Deploy a Stellar Asset Contract with the Stellar CLI | Guide | - - -
- -
- Custom smart contract tokens - - - -| | | | +| Custom smart contract tokens | | | | :-- | --- | --- | | [Asset and token intro](/docs/tokens) | Learn about the difference between assets issued on Stellar and custom smart contract tokens | Learn | | [Data availability overview](/docs/data) | Learn about the different mechanisms for data availability on Stellar | Learn | @@ -72,16 +60,11 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro -
- ### Smart contract developers -
- Essential resources - -| | | | +| Essential resources | | | | :-- | --- | --- | | [Stellar smart contracts overview](/docs/build/smart-contracts/overview) | Learn the essentials about writing smart contracts on Stellar | Learn | | [Migrating from EVM networks](/docs/learn/migrate) | Stellar is not an EVM network, learn about how Stellar differs from EVM networks in this section | Learn | @@ -92,32 +75,18 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Stellar CLI](/docs/build/guides/cli) | The command line interface to Stellar smart contracts | Tool | | [Rust SDK](https://docs.rs/soroban-sdk/latest/soroban_sdk/) | Supports writing programs for Stellar smart contracts | Tool | - - -
- -
- Optional resources - - - -| | | | +| Optional resources | | | | :-- | --- | --- | | [Trustlines](/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | Learn | | [Upgrading contracts](/docs/build/guides/conventions/upgrading-contracts) | You don’t need a proxy pattern to upgrade a contract (like in EVM), you can upgrade the Wasm bytecode directly without changing the address | Guide | -
- ### Ramps (anchors) -
- Ramps - -| | | | +| Ramps | | | | :-- | --- | --- | | [Anchor overview](/docs/learn/fundamentals/anchors) | Stellar ramps are called "anchors", learn about them in this overview section | Learn | | [SEP-6 and SEP-24](/docs/learn/fundamentals/anchors#using-sep-6-programmatic-deposit-and-withdrawal-versus-sep-24-hosted-deposit-and-withdrawal) | You can set up an anchor using SEP-6 or SEP-24, learn about the differences in this section | Learn | @@ -128,16 +97,11 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro -
- ### Applications -
- Traditional wallets - -| | | | +| Traditional Wallets | | | | :-- | --- | --- | | [Application design considerations](/docs/build/apps/application-design-considerations) | Various concepts to consider when building a wallet, such as custody models, security, and more | Learn | | [Fees](/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee) | Learn about how fees work on the Stellar network and decide how you'd like to handle user fees | Learn | @@ -147,19 +111,9 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Wallet SDK](/docs/category/build-a-wallet-with-the-wallet-sdk) | Learn to build a wallet with the Wallet SDK in Kotlin, Flutter, or TypeScript | Tutorial | | [Horizon introduction](/docs/data/horizon) | Access network data using the Horizon REST API | Data | - - -
- -
- Decentralized applications - -Start by viewing the [smart contract wayfinding section](#stellar-for-smart-contract-developers) - - - -| | | | +| Decentralized applications (dapps) | | | | :-- | --- | --- | +| Prolog | Start by viewing the [smart contract wayfinding section](#smart-contract-developers) | | | [Transaction simulation](/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | Learn | | [Dapp frontend](/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | Guide | | [Dapp how-to guides](/docs/build/guides/dapps) | Explore the various guides relating to dapp development | Guide | @@ -167,16 +121,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont | [Stellar JS SDK](https://stellar.github.io/js-stellar-sdk/) | Communicate with a Horizon server and Soroban RPC | Data | | [RPC introduction](/docs/data/rpc) | Access network data using the RPC | Data | - - -
- -
- Exchanges - - - -| | | | +| Exchanges | | | | :-- | --- | --- | | [List of operations](/docs/learn/fundamentals/transactions/list-of-operations) | Learn how operations function on the Stellar network, notably `CreateAccount`, `Payment`, and `ChangeTrust` | Learn | | [Trustlines](/docs/learn/fundamentals/stellar-data-structures/accounts#trustlines) | Trustlines are unique to Stellar and are an explicit opt-in for an account to hold and trade a particular asset | Learn | @@ -186,16 +131,11 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont -
- ### Infrastructure providers -
- Horizon - -| | | | +| Horizon | | | | :-- | --- | --- | | [Hardware requirements](/docs/data/requirements) | The recommended hardware requirements for users looking to set up a Horizon instance | Learn | | [Admin guide](/docs/data/requirements) | A comprehensive set of guides that will teach you how to administer a production Horizon instance | Tutorial | @@ -203,16 +143,7 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont | [SDK library](/docs/tools/sdks/library) | Use the various SDKs to simplify the Horizon setup process by using pre-built tools and libraries that make it easier to configure, manage, and connect to the network | Tool | | [Ecosystem providers](/docs/data/horizon/horizon-providers) | Create a PR in the docs to list your available Horizon service on this page | Tool | - - -
- -
- RPC - - - -| | | | +| Stellar RPC | | | | :-- | --- | --- | | [Hardware requirements](/docs/data/requirements) | The recommended hardware requirements for users looking to set up an RPC node | Learn | | [Admin guide](/docs/data/rpc/admin-guide) | A comprehensive guide that will teach you how to administer a production RPC node | Tutorial | @@ -222,24 +153,17 @@ Start by viewing the [smart contract wayfinding section](#stellar-for-smart-cont -
- ### Analytics -
- Hubble - -| | | | +| Hubble | | | | :-- | --- | --- | -| [Connecting to Hubble](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/connecting.mdx) | Connect to Hubble using one of three methods: BigQuery UI, BigQuery SDK, or Looker Studio | Learn | -| [Data catalog](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/data-catalog) | insert text | Learn | -| [Admin guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | Tutorial | -| [Analyst guide](https://github.com/stellar/stellar-docs/tree/main/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | Tutorial | -| [End-to-end example](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analyst-guide/end-to-end-analysis-example.mdx) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | Example | -| [Analytics platforms](https://github.com/stellar/stellar-docs/blob/main/docs/data/hubble/analytics-platforms.mdx) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | Tool | +| [Connecting to Hubble](/docs/data/hubble/analyst-guide/connecting) | Connect to Hubble using one of three methods: BigQuery UI, BigQuery SDK, or Looker Studio | Learn | +| [Data catalog](/docs/data/hubble/data-catalog) | View all Hubble data catalog information. | Learn | +| [Admin guide](/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | Tutorial | +| [Analyst guide](/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | Tutorial | +| [End-to-end example](/docs/data/hubble/analyst-guide/end-to-end-analysis-example) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | Example | +| [Analytics platforms](/docs/data/hubble/analytics-platforms) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | Tool | - -
From f8635e3e3707f7019291b6fd34327d42eebf02d2 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 14:34:29 -0600 Subject: [PATCH 39/40] prolog -> preface --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index d322b84ac..186522547 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -113,7 +113,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | Decentralized applications (dapps) | | | | :-- | --- | --- | -| Prolog | Start by viewing the [smart contract wayfinding section](#smart-contract-developers) | | +| Preface | Start by viewing the [smart contract wayfinding section](#smart-contract-developers) | | | [Transaction simulation](/docs/learn/encyclopedia/contract-development/contract-interactions/transaction-simulation) | A process that allows developers to test the outcome of a transaction without actually executing it, helping to ensure accuracy and prevent errors | Learn | | [Dapp frontend](/docs/build/apps/dapp-frontend) | Create a web app that interacts with the contracts via RPC calls | Guide | | [Dapp how-to guides](/docs/build/guides/dapps) | Explore the various guides relating to dapp development | Guide | From f561a0a0ef0e78e1e87e1680878bb4b5dfa20621 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Fri, 20 Dec 2024 14:44:17 -0600 Subject: [PATCH 40/40] fix a broken link --- src/pages/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 186522547..bd7de0960 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -163,7 +163,7 @@ Interact with other Stellar developers, keep up with ecosystem standards and pro | [Data catalog](/docs/data/hubble/data-catalog) | View all Hubble data catalog information. | Learn | | [Admin guide](/docs/data/hubble/admin-guide) | A comprehensive guide that will teach you how to run your own Hubble analytics platform | Tutorial | | [Analyst guide](/docs/data/hubble/analyst-guide) | A comprehensive guide that will teach you how to use Hubble for data analysis | Tutorial | -| [End-to-end example](/docs/data/hubble/analyst-guide/end-to-end-analysis-example) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | Example | +| [End-to-end example](/docs/data/hubble/analyst-guide/creating-visualizations) | A guide that will walk you through an end-to-end analysis use case with Hubble and Google Looker Studio | Example | | [Analytics platforms](/docs/data/hubble/analytics-platforms) | A list of data analytics platforms that use Hubble to provide a complete historical record of Pubnet data on the Stellar network | Tool |