From e38318abb06aa35622afb1d8dd54f19e5361a0ec Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Fri, 13 May 2022 13:20:43 -0700 Subject: [PATCH] Code samples cleanup: - Move Quickstart to a language folder - Copy-edits to code sample blurbs/titles --- .../_code-samples/address_encoding/README.md | 2 +- content/_code-samples/get-started/README.md | 2 +- content/_code-samples/quickstart/README.md | 21 ++---------------- .../quickstart/{ => js}/quickstart.zip | Bin .../_code-samples/tx-serialization/README.md | 2 +- .../quickstart/create-accounts-send-xrp.md | 4 ++-- .../create-trustline-send-currency.md | 4 ++-- .../quickstart/mint-and-burn-nftokens.md | 4 ++-- .../tutorials/quickstart/transfer-nftokens.md | 4 ++-- .../tutorials/quickstart/xrpl-quickstart.md | 2 +- 10 files changed, 14 insertions(+), 31 deletions(-) rename content/_code-samples/quickstart/{ => js}/quickstart.zip (100%) diff --git a/content/_code-samples/address_encoding/README.md b/content/_code-samples/address_encoding/README.md index 8ba71b63b3..5dd46feca8 100644 --- a/content/_code-samples/address_encoding/README.md +++ b/content/_code-samples/address_encoding/README.md @@ -1,3 +1,3 @@ # Address Encoding -Encode and decode XRP Ledger addresses in base58. (This implementation is equivalent to the ones included in most client libraries.) +Encode XRP Ledger addresses in base58. (This reference implementation is equivalent to the ones included in most client libraries.) diff --git a/content/_code-samples/get-started/README.md b/content/_code-samples/get-started/README.md index a6d421f82e..b6fc6da297 100644 --- a/content/_code-samples/get-started/README.md +++ b/content/_code-samples/get-started/README.md @@ -1,4 +1,4 @@ -# Get Started +# Introductory Code Samples Connect to the XRP Ledger and query it for data. diff --git a/content/_code-samples/quickstart/README.md b/content/_code-samples/quickstart/README.md index a3648e2e9e..ef4587b0c4 100644 --- a/content/_code-samples/quickstart/README.md +++ b/content/_code-samples/quickstart/README.md @@ -1,22 +1,5 @@ # Quickstart Samples Archive -Build a simple test interface for the XRPL. +Create a test harness for XRPL features using 4 iterative HTML pages and accompanying JavaScript files. -This folder contains the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive, which includes 4 iterative HTML pages as a test harness for XRPL features, with accompanying JavaScript files. The archive includes the following files: - -1.get-accounts-send--xrp.html - -2.create-trustline-send-currency.html - -3.mint-nfts.html - -4.transfer-nfts.html - - -ripplex1-send-xrp.js - -ripplex2-send-currency.js - -ripplex3-mint-nfts.js - -ripplex4-transfer-nfts.js +Get up and running with the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive, which includes 4 iterative HTML pages as a test harness for XRPL features, with accompanying JavaScript files. For the full explanation, see the [XRPL Quickstart Tutorial](https://xrpl.org/xrpl-quickstart.html). diff --git a/content/_code-samples/quickstart/quickstart.zip b/content/_code-samples/quickstart/js/quickstart.zip similarity index 100% rename from content/_code-samples/quickstart/quickstart.zip rename to content/_code-samples/quickstart/js/quickstart.zip diff --git a/content/_code-samples/tx-serialization/README.md b/content/_code-samples/tx-serialization/README.md index d3400c9b9e..1c866902c3 100644 --- a/content/_code-samples/tx-serialization/README.md +++ b/content/_code-samples/tx-serialization/README.md @@ -1,5 +1,5 @@ # Transaction Serialization -Convert transactions and other XRPL data from JSON to their canonical binary format for signing or cryptographic verification. +Convert transactions and other XRPL data from JSON to their canonical binary format for signing or cryptographic verification. (This reference implementation is equivalent to the ones included in most client libraries.) For a detailed explanation, see [Serialization](https://xrpl.org/serialization.html). diff --git a/content/tutorials/quickstart/create-accounts-send-xrp.md b/content/tutorials/quickstart/create-accounts-send-xrp.md index 2735874f16..dda28fff15 100644 --- a/content/tutorials/quickstart/create-accounts-send-xrp.md +++ b/content/tutorials/quickstart/create-accounts-send-xrp.md @@ -38,7 +38,7 @@ To get started, create a new folder on your local disk and install the JavaScrip ``` -Download and expand the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive. +Download and expand the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive. ## Usage @@ -89,7 +89,7 @@ To transfer XRP between accounts: # Code Walkthrough -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) in the source repository for this website. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) in the source repository for this website. diff --git a/content/tutorials/quickstart/create-trustline-send-currency.md b/content/tutorials/quickstart/create-trustline-send-currency.md index 27c56c74e5..c480d5f894 100644 --- a/content/tutorials/quickstart/create-trustline-send-currency.md +++ b/content/tutorials/quickstart/create-trustline-send-currency.md @@ -26,7 +26,7 @@ This example shows how to: ![Test harness with currency transfer](img/quickstart5.png) -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to try each of the samples in your own browser. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to try each of the samples in your own browser. ## Usage @@ -78,7 +78,7 @@ To transfer an issued currency token, once you have created a TrustLine: # Code Walkthrough -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to try each of the samples in your own browser. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to try each of the samples in your own browser. ## ripplex2-send-currency.js diff --git a/content/tutorials/quickstart/mint-and-burn-nftokens.md b/content/tutorials/quickstart/mint-and-burn-nftokens.md index e43a5b4028..30a0737cdd 100644 --- a/content/tutorials/quickstart/mint-and-burn-nftokens.md +++ b/content/tutorials/quickstart/mint-and-burn-nftokens.md @@ -26,7 +26,7 @@ This example shows how to: # Usage -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to try the sample in your own browser. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to try the sample in your own browser. ## Get Accounts @@ -100,7 +100,7 @@ To permanently destroy a NFToken: # Code Walkthrough -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to examine the code samples. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to examine the code samples. ## ripplex3-mint-nfts.js diff --git a/content/tutorials/quickstart/transfer-nftokens.md b/content/tutorials/quickstart/transfer-nftokens.md index 218512263d..561b907930 100644 --- a/content/tutorials/quickstart/transfer-nftokens.md +++ b/content/tutorials/quickstart/transfer-nftokens.md @@ -27,7 +27,7 @@ This example shows how to: ![Quickstart form with NFToken transfer fields](img/quickstart13.png) -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to try each of the samples in your own browser. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to try each of the samples in your own browser. # Usage @@ -158,7 +158,7 @@ To cancel a buy or sell offer that you have created: # Code Walkthrough -You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive to try each of the samples in your own browser. +You can download the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive to try each of the samples in your own browser. ## Create Sell Offer diff --git a/content/tutorials/quickstart/xrpl-quickstart.md b/content/tutorials/quickstart/xrpl-quickstart.md index 67ef83dbc5..000d210e50 100644 --- a/content/tutorials/quickstart/xrpl-quickstart.md +++ b/content/tutorials/quickstart/xrpl-quickstart.md @@ -52,7 +52,7 @@ To get started, create a new folder on your local disk and install the JavaScrip ``` -Download and expand the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/quickstart.zip) archive. +Download and expand the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/quickstart/js/quickstart.zip) archive. ---