diff --git a/README.md b/README.md index 4d79beb8b..21ac4334f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Welcome to the official home repository for [Documentation][docs] and [API Reference][api] for the [Stellar Network][stellar]. -# Table of Contents +## Table of Contents - [Contributing](#contributing) - [Quick Start](#quick-start) @@ -14,7 +14,7 @@ Welcome to the official home repository for [Documentation][docs] and - [Alert](#alert) - [Code Example](#code-example) -# Contributing +## Contributing Contributions are more than welcome! Thank you! 🎉 @@ -29,8 +29,8 @@ helpful and meaningful way. Markdown is super easy to learn, and will come quite naturally after only a bit of practice. You can always help fix typos, spelling, and broken links, too. -# Quick Start -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][codespaces] +## Quick Start +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][codespaces] [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod] To begin development on the documentation, you will first need [yarn][yarn] @@ -55,7 +55,7 @@ npm run check:mdx # this will search for problems in the MDX files npm run format:mdx # this will fix any problems that were found ``` -# Repository Structure +## Repository Structure - `/docs/` Contains all the documentation content. If you're contributing to the actual documentation, rather than site functionality, this is likely where you @@ -88,9 +88,9 @@ npm run format:mdx # this will fix any problems that were found case-by-case basis, and it may be determined that a redirect isn't the right approach in some instances.) -# Using Markdown +## Using Markdown -## Markdown Basics +### Markdown Basics If you're unfamiliar with Markdown, there are **loads** of good tutorials and cheat sheets out there. Check out some of these resources to get a handle on the @@ -100,24 +100,24 @@ basics: - [Interactive markdown tutorial][tutorial] - [The markdown guide][guide] -## Custom Markdown +### Custom Markdown Our repository uses some custom React components that can be used inside the `MDX` documents. Use them as follows: **Make sure that there is an empty line within the wrapper.** For example, -``` +```text -Note: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../fundamentals-and-concepts/testnet-and-pubnet). +Note: the testnet is reset every three months, so when building on it, make sure you have a plan to recreate necessary accounts and other data. For more info, check out the [best practices for using the testnet](../../learn/fundamentals/networks.mdx). ``` -### Alert +#### Alert ![Testnet reset alert](./readme-imgs/alert.png) @@ -134,7 +134,7 @@ Note: the testnet is reset every three months, so when building on it, make sure ``` -### Code Example +#### Code Example ![Create account code example](./readme-imgs/code-example.png) diff --git a/docs/building-apps/application-design-considerations.mdx b/docs/building-apps/application-design-considerations.mdx index 25fd61819..30542296b 100644 --- a/docs/building-apps/application-design-considerations.mdx +++ b/docs/building-apps/application-design-considerations.mdx @@ -11,7 +11,7 @@ There are four custody options to consider: - Non-custodial service - the user of the application stores their own secret key - Custodial service - the service provider (application) stores the users’ secret keys -- Mixture of both - with the use of [multisig](../encyclopedia/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery +- Mixture of both - with the use of [multisig](../learn/encyclopedia/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery - Third-party key management services - integrate a third-party custodial service into your application that can store your users’ secret keys ### Non-custodial service @@ -24,13 +24,13 @@ Typically, non-custodial applications create or import a pre-existing Stellar ac With a custodial service, the service provider (an application such as a centralized exchange) stores the users’ secret keys and delegates usage rights to the user. -Many custodial services choose to use a single pooled Stellar account (called shared, omnibus, or [pooled accounts](https://developers.stellar.org/docs/encyclopedia/pooled-accounts-muxed-accounts-memos)) to handle transactions on behalf of their users instead of creating a new Stellar account for each user. To distinguish between individual users in a pooled account, we encourage the implementation of [muxed accounts](https://developers.stellar.org/docs/encyclopedia/pooled-accounts-muxed-accounts-memos#muxed-accounts). +Many custodial services choose to use a single pooled Stellar account (called shared, omnibus, or [pooled accounts](../learn/encyclopedia/pooled-accounts-muxed-accounts-memos.mdx)) to handle transactions on behalf of their users instead of creating a new Stellar account for each user. To distinguish between individual users in a pooled account, we encourage the implementation of [muxed accounts](../learn/encyclopedia/pooled-accounts-muxed-accounts-memos.mdx#muxed-accounts). Learn how to set up an application as a custodial service in this [tutorial]. ### A mixture of non-custodial and custodial -Building an application with [multi-signature](../encyclopedia/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough. +Building an application with [multi-signature](../learn/encyclopedia/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough. ### Third-party key management services​ @@ -95,7 +95,7 @@ The flow with Claimable Balances looks like this: ### Option 2: the wallet creates and funds the Stellar account upon user sign-up​ -For this option, the wallet creates and funds the Stellar account upon every new user sign-up with the minimum requirement of 1XLM, plus the .5XLM reserve for establishing the first trustline, plus a bit more to cover transaction fees. For more information on minimum balances, check out the [Lumens section](https://developers.stellar.org/docs/fundamentals-and-concepts/lumens#minimum-balance). +For this option, the wallet creates and funds the Stellar account upon every new user sign-up with the minimum requirement of 1XLM, plus the .5XLM reserve for establishing the first trustline, plus a bit more to cover transaction fees. For more information on minimum balances, check out the [Lumens section](../learn/fundamentals/lumens.mdx#minimum-balance). The flow looks like this: diff --git a/docs/building-apps/example-application-tutorial/account-creation.mdx b/docs/building-apps/example-application-tutorial/account-creation.mdx index 6b4aab838..4a8b1aed1 100644 --- a/docs/building-apps/example-application-tutorial/account-creation.mdx +++ b/docs/building-apps/example-application-tutorial/account-creation.mdx @@ -188,8 +188,8 @@ Source: https://github.com/stellar/basic-payment-app/blob/main/src/lib/stellar/h Our `walletStore` is used in a ton of places in our application, especially in the confirmation modal when asking a user to input their pincode. Read on to see how we've done that. -[accounts section]: ../../fundamentals-and-concepts/stellar-data-structures/accounts +[accounts section]: ../../learn/fundamentals/stellar-data-structures/accounts.mdx [non-custodial application]: ../application-design-considerations#non-custodial-service [`js-stellar-wallets` sdk]: https://github.com/stellar/js-stellar-wallets -[sponsored reserves]: ../../encyclopedia/sponsored-reserves +[sponsored reserves]: ../../learn/encyclopedia/sponsored-reserves.mdx [contacts list]: ./contacts-list diff --git a/docs/building-apps/example-application-tutorial/anchor-integration/setup.mdx b/docs/building-apps/example-application-tutorial/anchor-integration/setup.mdx index f05ca1a92..7be37f673 100644 --- a/docs/building-apps/example-application-tutorial/anchor-integration/setup.mdx +++ b/docs/building-apps/example-application-tutorial/anchor-integration/setup.mdx @@ -11,7 +11,7 @@ In this example, we’ll use an anchor on Stellar’s Testnet to simulate a bank :::info -SEPs define community-decided standards for interoperability on Stellar. Read more in our [SEPs section](../../../fundamentals-and-concepts/stellar-ecosystem-proposals). +SEPs define community-decided standards for interoperability on Stellar. Read more in our [SEPs section](../../../learn/fundamentals/stellar-ecosystem-proposals.mdx). ::: diff --git a/docs/building-apps/example-application-tutorial/manage-trust.mdx b/docs/building-apps/example-application-tutorial/manage-trust.mdx index d2f957652..cbab3b36c 100644 --- a/docs/building-apps/example-application-tutorial/manage-trust.mdx +++ b/docs/building-apps/example-application-tutorial/manage-trust.mdx @@ -3,7 +3,7 @@ title: Manage Trust sidebar_position: 30 --- -For an account to hold and trade assets other than XLM, it must establish a [trustline](../../fundamentals-and-concepts/stellar-data-structures/accounts#trustlines) with the issuing account of that particular asset. Each trustline increases the account’s [base reserve](../../fundamentals-and-concepts/stellar-data-structures/accounts#base-reserves-and-subentries) by 0.5 XLM, which means the account will have to hold more XLM in its minimum balance. +For an account to hold and trade assets other than XLM, it must establish a [trustline](../../learn/fundamentals/stellar-data-structures/accounts.mdx#trustlines) with the issuing account of that particular asset. Each trustline increases the account’s [base reserve](../../learn/fundamentals/stellar-data-structures/accounts.mdx#base-reserves-and-subentries) by 0.5 XLM, which means the account will have to hold more XLM in its minimum balance. ## User experience @@ -11,7 +11,7 @@ First, we’ll have the user create a trustline for an asset by navigating to th :::info -An asset is displayed as an asset code and issuer address. Learn more in our [Assets section](https://developers.stellar.org/docs/fundamentals-and-concepts/stellar-data-structures/assets). +An asset is displayed as an asset code and issuer address. Learn more in our [Assets section](../../learn/fundamentals/stellar-data-structures/assets.mdx). ::: diff --git a/docs/building-apps/example-application-tutorial/path-payment.mdx b/docs/building-apps/example-application-tutorial/path-payment.mdx index 04dd79cff..0aba8834b 100644 --- a/docs/building-apps/example-application-tutorial/path-payment.mdx +++ b/docs/building-apps/example-application-tutorial/path-payment.mdx @@ -3,7 +3,7 @@ title: Path Payment sidebar_position: 50 --- -A path payment is where the asset sent can be different from the asset received. There are two possible path payment operations: 1) `path_payment_strict_send`, which allows the user to specify the amount of the asset to send, and 2) `path_payment_strict_receive`, which allows the user to specify the amount of the asset received. Read more in the [Path Payments Encyclopedia Entry](../../encyclopedia/path-payments). +A path payment is where the asset sent can be different from the asset received. There are two possible path payment operations: 1) `path_payment_strict_send`, which allows the user to specify the amount of the asset to send, and 2) `path_payment_strict_receive`, which allows the user to specify the amount of the asset received. Read more in the [Path Payments Encyclopedia Entry](../../learn/encyclopedia/path-payments.mdx). ## User experience @@ -17,7 +17,7 @@ The user will then preview the transaction, input their pincode, and select the ### The `/dashboard/send` page -Most of this page has been discussed in the [Payment section](./payment#the-dashboardsend-page). Below, we're highlighting the unique pieces that are added to BasicPay to allow for the path payment feature. +Most of this page has been discussed in the [Payment section](./payment.mdx#the-dashboardsend-page). Below, we're highlighting the unique pieces that are added to BasicPay to allow for the path payment feature. ```html title="/src/routes/dashboard/send/+page.svelte"