Re-levelization: move non-docs content, rename content→docs

For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
This commit is contained in:
mDuo13
2024-01-31 17:53:52 -08:00
parent 971053ebcc
commit 7645140477
844 changed files with 3136 additions and 3458 deletions

View File

@@ -36,7 +36,7 @@ An [Automated Market Maker (AMM)](../../concepts/tokens/decentralized-exchange/a
Complete sample code for all of the steps of these tutorials is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Create an AMM](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/create-amm/) in the source repository for this website.
- See [Code Samples: Create an AMM](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/create-amm/) in the source repository for this website.
## Steps
@@ -55,13 +55,13 @@ You must be connected to the network to query it and submit transactions. The fo
For this tutorial, click the following button to connect:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 2. Get credentials
To transact on the XRP Ledger, you need an address, a secret key, and some XRP. For development and testing purposes, you can get these on the [{{use_network}}](../../concepts/networks-and-servers/parallel-networks.md) using the following interface:
{% partial file="/_snippets/interactive-tutorials/generate-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}
When you're building production-ready software, you should use an existing account, and manage your keys using a [secure signing configuration](../../concepts/transactions/secure-signing.md). The following code shows how to get a `Wallet` instance using either the faucet or a seed provided by environment variable:
@@ -285,4 +285,4 @@ When you want to withdraw liquidity from the AMM, you can use [AMMDeposit][] to
However, you should keep an eye on market conditions, and use tools like [AMMBid][] and [AMMVote][] to insulate yourself from losses due to changes in the relative value of the two assets in the pool.
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -30,7 +30,7 @@ If you [issue tokens](../../concepts/tokens/index.md) in the XRP Ledger, can ena
Complete sample code for all of the steps of this tutorial is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/freeze/) in the source repository for this website.
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/freeze/) in the source repository for this website.
## Steps
@@ -42,7 +42,7 @@ To transact on the XRP Ledger, you need an address and secret key, and some XRP.
For this tutorial, you can get credentials from the following interface:
{% partial file="/_snippets/interactive-tutorials/generate-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}
When you're building production-ready software, you should use an existing account, and manage your keys using a [secure signing configuration](../../concepts/transactions/secure-signing.md).
@@ -61,7 +61,7 @@ You must be connected to the network to submit transactions to it. The following
For this tutorial, click the following button to connect:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 3. Send AccountSet Transaction
@@ -114,7 +114,7 @@ For example:
Most transactions are accepted into the next ledger version after they're submitted, which means it may take 4-7 seconds for a transaction's outcome to be final. If the XRP Ledger is busy or poor network connectivity delays a transaction from being relayed throughout the network, a transaction may take longer to be confirmed. (For information on how to set an expiration for transactions, see [Reliable Transaction Submission](../../concepts/transactions/reliable-transaction-submission.md).)
{% partial file="/_snippets/interactive-tutorials/wait-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" /%}
### 5. Confirm Account Settings
@@ -199,4 +199,4 @@ Response:
- [AccountRoot Flags](../../references/protocol/ledger-data/ledger-entry-types/accountroot.md#accountroot-flags)
- [RippleState (trust line) Flags](../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md#ripplestate-flags)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -32,7 +32,7 @@ If you [issue tokens](../../concepts/tokens/index.md) in the XRP Ledger, can ena
Complete sample code for all of the steps of this tutorial is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/freeze/) in the source repository for this website.
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/freeze/) in the source repository for this website.
## Steps
@@ -44,7 +44,7 @@ To transact on the XRP Ledger, you need an address and secret key, and some XRP.
For this tutorial, you can get credentials from the following interface:
{% partial file="/_snippets/interactive-tutorials/generate-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}
When you're building production-ready software, you should use an existing account, and manage your keys using a [secure signing configuration](../../concepts/transactions/secure-signing.md).
@@ -63,7 +63,7 @@ You must be connected to the network to submit transactions to it. The following
For this tutorial, click the following button to connect:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 3. Send AccountSet Transaction to Start the Freeze
@@ -118,7 +118,7 @@ Most transactions are accepted into the next ledger version after they're submit
{% interactive-block label="Wait" steps=$frontmatter.steps %}
{% partial file="/_snippets/interactive-tutorials/wait-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" /%}
{% /interactive-block %}
@@ -250,7 +250,7 @@ For example:
As before, wait for the previous transaction to be validated by consensus before continuing.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (again)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (again)"} /%}
### 8. Confirm Account Settings
@@ -285,4 +285,4 @@ After the transaction is validated, you can confirm the status of the Global Fre
- [AccountRoot Flags](../../references/protocol/ledger-data/ledger-entry-types/accountroot.md#accountroot-flags)
- [RippleState (trust line) Flags](../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md#ripplestate-flags)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -35,7 +35,7 @@ This tutorial shows the steps to [freeze an individual trust line](../../concept
Complete sample code for all of the steps of this tutorial is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/freeze/) in the source repository for this website.
- See [Code Samples: Freeze](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/freeze/) in the source repository for this website.
## Steps
@@ -43,7 +43,7 @@ Complete sample code for all of the steps of this tutorial is available under th
To transact on the XRP Ledger, you need an address and secret key, and some XRP. If you use the best practice of having separate ["cold" and "hot" addresses](../../concepts/accounts/account-types.md), you need the keys to the _cold address_, which is the **issuer** of the token.
{% partial file="/_snippets/interactive-tutorials/generate-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}
### 2. Connect to the Network
@@ -65,7 +65,7 @@ You must be connected to the network to submit transactions to it. The following
For purposes of this tutorial, use the following interface to connect and perform setup:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 3. Choose Trust Line
@@ -202,7 +202,7 @@ As always, to send a transaction, you _prepare_ it by filling in all the necessa
Most transactions are accepted into the next ledger version after they're submitted, which means it may take 4-7 seconds for a transaction's outcome to be final. If the XRP Ledger is busy or poor network connectivity delays a transaction from being relayed throughout the network, a transaction may take longer to be confirmed. (For information on how to set an expiration for transactions, see [Reliable Transaction Submission](../../concepts/transactions/reliable-transaction-submission.md).)
{% partial file="/_snippets/interactive-tutorials/wait-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" /%}
### 6. Check Trust Line Freeze Status
@@ -335,7 +335,7 @@ As always, to send a transaction, you _prepare_ it by filling in all the necessa
As before, wait for the transaction to be validated by consensus.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (again)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (again)"} /%}
@@ -356,4 +356,4 @@ As before, wait for the transaction to be validated by consensus.
- [AccountRoot Flags](../../references/protocol/ledger-data/ledger-entry-types/accountroot.md#accountroot-flags)
- [RippleState (trust line) Flags](../../references/protocol/ledger-data/ledger-entry-types/ripplestate.md#ripplestate-flags)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -33,7 +33,7 @@ Anyone can issue various types of tokens in the XRP Ledger, ranging from informa
Complete sample code for all of the steps of these tutorials is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Issue a Fungible Token](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/issue-a-token/) in the source repository for this website.
- See [Code Samples: Issue a Fungible Token](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/issue-a-token/) in the source repository for this website.
## Steps
@@ -87,7 +87,7 @@ You must be connected to the network to submit transactions to it. The following
For this tutorial, click the following button to connect:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 3. Configure Issuer Settings
@@ -205,13 +205,13 @@ Most transactions are accepted into the next ledger version after they're submit
The code samples in this tutorial use helper functions to wait for validation when submitting a transaction:
- **JavaScript:** The `submit_and_verify()` function, as defined in the [submit-and-verify code sample](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/submit-and-verify).
- **JavaScript:** The `submit_and_verify()` function, as defined in the [submit-and-verify code sample](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/submit-and-verify).
- **Python:** The `submit_and_wait()` [method of the xrpl-py library](https://xrpl-py.readthedocs.io/en/stable/source/xrpl.transaction.html#xrpl.transaction.submit_and_wait).
- **Java:** The `submitAndWaitForValidation()` method in the [sample Java class](https://github.com/XRPLF/xrpl-dev-portal/blob/master/content/_code-samples/issue-a-token/java/IssueToken.java).
- **Java:** The `submitAndWaitForValidation()` method in the [sample Java class](https://github.com/XRPLF/xrpl-dev-portal/blob/master/_code-samples/issue-a-token/java/IssueToken.java).
**Tip:** Technically, you can configure the hot address in parallel with configuring the issuer address. For simplicity, this tutorial waits for each transaction one at a time.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Issuer Setup)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Issuer Setup)"} /%}
### 5. Configure Hot Address Settings
@@ -299,7 +299,7 @@ The following code sample shows how to send an [AccountSet transaction][] to ena
As before, wait for the previous transaction to be validated by consensus before continuing.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Hot Address Setup)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Hot Address Setup)"} /%}
### 7. Create Trust Line from Hot to Cold Address
@@ -383,7 +383,7 @@ The following code sample shows how to send a [TrustSet transaction][] from the
As before, wait for the previous transaction to be validated by consensus before continuing.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (TrustSet)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (TrustSet)"} /%}
### 9. Send Token
@@ -460,7 +460,7 @@ The following code sample shows how to send a [Payment transaction][] to issue 8
As before, wait for the previous transaction to be validated by consensus before continuing.
{% partial file="/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Payment)"} /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" variables={label: "Wait (Payment)"} /%}
### 11. Confirm Token Balances
@@ -517,4 +517,4 @@ Now that you've created the token, you can explore how it fits into features of
¹ Users can hold your token without explicitly creating a trust line if they buy your token in the [decentralized exchange](../../concepts/tokens/decentralized-exchange/index.md). Buying a token in the exchange [automatically creates the necessary trust lines](../../concepts/tokens/decentralized-exchange/offers.md#offers-and-trust). This is only possible if someone is selling your token in the decentralized exchange.
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

View File

@@ -31,7 +31,7 @@ This tutorial demonstrates how you can buy and sell tokens in the [decentralized
Complete sample code for all of the steps of this tutorial is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
- See [Code Samples: Trade in the Decentralized Exchange](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/trade-in-the-decentralized-exchange/) in the source repository for this website.
- See [Code Samples: Trade in the Decentralized Exchange](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/trade-in-the-decentralized-exchange/) in the source repository for this website.
## Steps
@@ -63,13 +63,13 @@ You must be connected to the network to submit transactions to it. Additionally,
For this tutorial, click the following button to connect:
{% partial file="/_snippets/interactive-tutorials/connect-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/connect-step.md" /%}
### 2. Get Credentials
To transact on the XRP Ledger, you need an address, a secret key, and some XRP. For development purposes, you can get these on the [{{use_network}}](../../concepts/networks-and-servers/parallel-networks.md) using the following interface:
{% partial file="/_snippets/interactive-tutorials/generate-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}
When you're building production-ready software, you should use an existing account, and manage your keys using a [secure signing configuration](../../concepts/transactions/secure-signing.md). The following code shows how to create a `Wallet` instance to use your keys:
@@ -195,7 +195,7 @@ You can use this interface to send the transaction specified by the amounts in t
Most transactions are accepted into the next ledger version after they're submitted, which means it may take 4-7 seconds for a transaction's outcome to be final. If the XRP Ledger is busy or poor network connectivity delays a transaction from being relayed throughout the network, a transaction may take longer to be confirmed. (For information on how to set an expiration for transactions, see [Reliable Transaction Submission](../../concepts/transactions/reliable-transaction-submission.md).)
{% partial file="/_snippets/interactive-tutorials/wait-step.md" /%}
{% partial file="/docs/_snippets/interactive-tutorials/wait-step.md" /%}
### 5. Check Metadata
@@ -263,4 +263,4 @@ You can use this interface to test it out:
{% /interactive-block %}
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}