From 48391ba3d545d90951d64a1ee3e1d70b272c30f5 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 3 May 2018 15:28:40 -0700 Subject: [PATCH] References general file structure (methods) --- ...ence-amendments.md => known-amendments.md} | 0 .../{reference-data-api.md => data-api.md} | 0 content/references/references.md | 41 -- .../validation_create.md | 0 .../key-generation-methods}/wallet_propose.md | 0 .../can_delete.md | 0 .../ledger_cleaner.md | 0 .../ledger_request.md | 0 .../log_level.md | 0 .../logrotate.md | 0 .../server-control-methods}/connect.md | 0 .../server-control-methods}/ledger_accept.md | 0 .../server-control-methods}/stop.md | 0 .../validation_seed.md | 0 .../consensus_info.md | 0 .../status-and-debugging-methods}/feature.md | 0 .../fetch_info.md | 0 .../get_counts.md | 0 .../status-and-debugging-methods}/peers.md | 0 .../status-and-debugging-methods}/print.md | 0 .../validator_list_sites.md | 0 .../validators.md | 0 .../api-conventions/api-conventions.md | 5 + .../api-conventions/currency-formatting.md} | 0 .../ledger-data-formats/ledger-format.md} | 0 .../ledger-objects/accountroot.md | 0 .../ledger-objects/amendments.md | 0 .../ledger-objects/check.md | 0 .../ledger-objects/directorynode.md | 0 .../ledger-objects/escrow.md | 0 .../ledger-objects/feesettings.md | 0 .../ledger-objects/ledgerhashes.md | 0 .../ledger-objects/offer.md | 0 .../ledger-objects/paychannel.md | 0 .../ledger-objects/ripplestate.md | 0 .../ledger-objects/signerlist.md | 0 .../account-methods}/account_channels.md | 0 .../account-methods}/account_currencies.md | 0 .../account-methods}/account_info.md | 0 .../account-methods}/account_lines.md | 0 .../account-methods}/account_objects.md | 0 .../account-methods}/account_offers.md | 0 .../account-methods}/account_tx.md | 0 .../account-methods}/gateway_balances.md | 0 .../account-methods}/noripple_check.md | 0 .../ledger-methods}/ledger.md | 0 .../ledger-methods}/ledger_closed.md | 0 .../ledger-methods}/ledger_current.md | 0 .../ledger-methods}/ledger_data.md | 0 .../ledger-methods}/ledger_entry.md | 0 .../book_offers.md | 0 .../path-and-order-book-methods}/path_find.md | 0 .../ripple_path_find.md | 0 .../channel_authorize.md | 0 .../channel_verify.md | 0 .../server-info-methods}/fee.md | 0 .../server-info-methods}/server_info.md | 0 .../server-info-methods}/server_state.md | 0 .../subscription-methods}/subscribe.md | 0 .../subscription-methods}/unsubscribe.md | 0 .../transaction-methods}/sign.md | 0 .../transaction-methods}/sign_for.md | 0 .../transaction-methods}/submit.md | 0 .../submit_multisigned.md | 0 .../transaction-methods}/transaction_entry.md | 0 .../transaction-methods}/tx.md | 0 .../transaction-methods}/tx_history.md | 0 .../utility-methods}/json.md | 0 .../utility-methods}/ping.md | 0 .../utility-methods}/random.md | 0 .../rippled-api-admin-landing.md} | 0 .../rippled-api-conventions-landing.md} | 0 .../rippled-api-landing.md} | 0 ...rippled-api-ledger-data-format-landing.md} | 0 .../rippled-api-public-landing.md} | 0 ...rippled-api-transaction-format-landing.md} | 0 .../rippled.md} | 2 +- .../transaction-format.md} | 0 .../transaction-types}/accountset.md | 0 .../transaction-types}/checkcancel.md | 0 .../transaction-types}/checkcash.md | 0 .../transaction-types}/checkcreate.md | 0 .../transaction-types}/enableamendment.md | 0 .../transaction-types}/escrowcancel.md | 0 .../transaction-types}/escrowcreate.md | 0 .../transaction-types}/escrowfinish.md | 0 .../transaction-types}/offercancel.md | 0 .../transaction-types}/offercreate.md | 0 .../transaction-types}/payment.md | 0 .../transaction-types}/paymentchannelclaim.md | 0 .../paymentchannelcreate.md | 0 .../transaction-types}/paymentchannelfund.md | 0 .../transaction-types}/setfee.md | 0 .../transaction-types}/setregularkey.md | 0 .../transaction-types}/signerlistset.md | 0 .../transaction-types}/trustset.md | 0 ...use-case-listing-xrp.md => listing-xrp.md} | 0 dactyl-config.yml | 573 +++++++++--------- ....html => template-websocket-api-tool.html} | 0 99 files changed, 297 insertions(+), 324 deletions(-) rename content/news/{reference-amendments.md => known-amendments.md} (100%) rename content/references/{reference-data-api.md => data-api.md} (100%) delete mode 100644 content/references/references.md rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/key-generation-methods}/validation_create.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/key-generation-methods}/wallet_propose.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/logging-and-data-management-methods}/can_delete.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/logging-and-data-management-methods}/ledger_cleaner.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/logging-and-data-management-methods}/ledger_request.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/logging-and-data-management-methods}/log_level.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/logging-and-data-management-methods}/logrotate.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/server-control-methods}/connect.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/server-control-methods}/ledger_accept.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/server-control-methods}/stop.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/server-control-methods}/validation_seed.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/consensus_info.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/feature.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/fetch_info.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/get_counts.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/peers.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/print.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/validator_list_sites.md (100%) rename content/references/{rippled-api-methods => rippled-api/admin-rippled-methods/status-and-debugging-methods}/validators.md (100%) create mode 100644 content/references/rippled-api/api-conventions/api-conventions.md rename content/references/{reference-currency.md => rippled-api/api-conventions/currency-formatting.md} (100%) rename content/references/{reference-ledger-format.md => rippled-api/ledger-data-formats/ledger-format.md} (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/accountroot.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/amendments.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/check.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/directorynode.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/escrow.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/feesettings.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/ledgerhashes.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/offer.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/paychannel.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/ripplestate.md (100%) rename content/references/{ => rippled-api/ledger-data-formats}/ledger-objects/signerlist.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_channels.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_currencies.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_info.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_lines.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_objects.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_offers.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/account_tx.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/gateway_balances.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/account-methods}/noripple_check.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/ledger-methods}/ledger.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/ledger-methods}/ledger_closed.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/ledger-methods}/ledger_current.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/ledger-methods}/ledger_data.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/ledger-methods}/ledger_entry.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/path-and-order-book-methods}/book_offers.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/path-and-order-book-methods}/path_find.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/path-and-order-book-methods}/ripple_path_find.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/payment-channel-methods}/channel_authorize.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/payment-channel-methods}/channel_verify.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/server-info-methods}/fee.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/server-info-methods}/server_info.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/server-info-methods}/server_state.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/subscription-methods}/subscribe.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/subscription-methods}/unsubscribe.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/sign.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/sign_for.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/submit.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/submit_multisigned.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/transaction_entry.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/tx.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/transaction-methods}/tx_history.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/utility-methods}/json.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/utility-methods}/ping.md (100%) rename content/references/{rippled-api-methods => rippled-api/public-rippled-methods/utility-methods}/random.md (100%) rename content/references/{reference-rippled-api-admin-landing.md => rippled-api/rippled-api-admin-landing.md} (100%) rename content/references/{reference-rippled-api-conventions-landing.md => rippled-api/rippled-api-conventions-landing.md} (100%) rename content/references/{reference-rippled-api-landing.md => rippled-api/rippled-api-landing.md} (100%) rename content/references/{reference-rippled-api-ledger-data-format-landing.md => rippled-api/rippled-api-ledger-data-format-landing.md} (100%) rename content/references/{reference-rippled-api-public-landing.md => rippled-api/rippled-api-public-landing.md} (100%) rename content/references/{reference-rippled-api-transaction-format-landing.md => rippled-api/rippled-api-transaction-format-landing.md} (100%) rename content/references/{reference-rippled.md => rippled-api/rippled.md} (99%) rename content/references/{reference-transaction-format.md => rippled-api/transaction-formats/transaction-format.md} (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/accountset.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/checkcancel.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/checkcash.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/checkcreate.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/enableamendment.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/escrowcancel.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/escrowcreate.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/escrowfinish.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/offercancel.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/offercreate.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/payment.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/paymentchannelclaim.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/paymentchannelcreate.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/paymentchannelfund.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/setfee.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/setregularkey.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/signerlistset.md (100%) rename content/references/{transactions => rippled-api/transaction-formats/transaction-types}/trustset.md (100%) rename content/use-cases/{use-case-listing-xrp.md => listing-xrp.md} (100%) rename tool/{template-ripple-api-tool.html => template-websocket-api-tool.html} (100%) diff --git a/content/news/reference-amendments.md b/content/news/known-amendments.md similarity index 100% rename from content/news/reference-amendments.md rename to content/news/known-amendments.md diff --git a/content/references/reference-data-api.md b/content/references/data-api.md similarity index 100% rename from content/references/reference-data-api.md rename to content/references/data-api.md diff --git a/content/references/references.md b/content/references/references.md deleted file mode 100644 index 4164297e50..0000000000 --- a/content/references/references.md +++ /dev/null @@ -1,41 +0,0 @@ -# References - -## [`rippled` API Reference](x) - -Use the `rippled` API to communicate with a `rippled` server, the core peer-to-peer server that manages the XRP Ledger. - -### [Public `rippled` API Methods](x) -Communicate directly with a `rippled` server using these public API methods. - - -### [Admin `rippled` API Methods](x) -Communicate directly with a `rippled` server using these admin-only API methods. - - -### [Transaction Formats](x) -A transaction is the only way to modify the XRP Ledger. Get details about its required format. - - -### [Ledger Data Formats](x) -Learn about the format of individual ledgers that make up the shared, global XRP Ledger. - - -### [API Conventions](x) -Get details about these common conventions used across the `rippled` API. - - - -## Other `rippled` API Interfaces -Here are a couple of other ways to interface with the `rippled` API. - -### [ripple-lib for JavaScript Reference](x) - -Official client library to the XRP Ledger. Available for JavaScript only. - - - -### [Data API v2 Reference](x) - -Access info about changes to the XRP Ledger, including transaction history and analytics. - - diff --git a/content/references/rippled-api-methods/validation_create.md b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md similarity index 100% rename from content/references/rippled-api-methods/validation_create.md rename to content/references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md diff --git a/content/references/rippled-api-methods/wallet_propose.md b/content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md similarity index 100% rename from content/references/rippled-api-methods/wallet_propose.md rename to content/references/rippled-api/admin-rippled-methods/key-generation-methods/wallet_propose.md diff --git a/content/references/rippled-api-methods/can_delete.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md similarity index 100% rename from content/references/rippled-api-methods/can_delete.md rename to content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/can_delete.md diff --git a/content/references/rippled-api-methods/ledger_cleaner.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md similarity index 100% rename from content/references/rippled-api-methods/ledger_cleaner.md rename to content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md diff --git a/content/references/rippled-api-methods/ledger_request.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md similarity index 100% rename from content/references/rippled-api-methods/ledger_request.md rename to content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_request.md diff --git a/content/references/rippled-api-methods/log_level.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md similarity index 100% rename from content/references/rippled-api-methods/log_level.md rename to content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/log_level.md diff --git a/content/references/rippled-api-methods/logrotate.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md similarity index 100% rename from content/references/rippled-api-methods/logrotate.md rename to content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md diff --git a/content/references/rippled-api-methods/connect.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md similarity index 100% rename from content/references/rippled-api-methods/connect.md rename to content/references/rippled-api/admin-rippled-methods/server-control-methods/connect.md diff --git a/content/references/rippled-api-methods/ledger_accept.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md similarity index 100% rename from content/references/rippled-api-methods/ledger_accept.md rename to content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md diff --git a/content/references/rippled-api-methods/stop.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md similarity index 100% rename from content/references/rippled-api-methods/stop.md rename to content/references/rippled-api/admin-rippled-methods/server-control-methods/stop.md diff --git a/content/references/rippled-api-methods/validation_seed.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md similarity index 100% rename from content/references/rippled-api-methods/validation_seed.md rename to content/references/rippled-api/admin-rippled-methods/server-control-methods/validation_seed.md diff --git a/content/references/rippled-api-methods/consensus_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md similarity index 100% rename from content/references/rippled-api-methods/consensus_info.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md diff --git a/content/references/rippled-api-methods/feature.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md similarity index 100% rename from content/references/rippled-api-methods/feature.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/feature.md diff --git a/content/references/rippled-api-methods/fetch_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md similarity index 100% rename from content/references/rippled-api-methods/fetch_info.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md diff --git a/content/references/rippled-api-methods/get_counts.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md similarity index 100% rename from content/references/rippled-api-methods/get_counts.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md diff --git a/content/references/rippled-api-methods/peers.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md similarity index 100% rename from content/references/rippled-api-methods/peers.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md diff --git a/content/references/rippled-api-methods/print.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md similarity index 100% rename from content/references/rippled-api-methods/print.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md diff --git a/content/references/rippled-api-methods/validator_list_sites.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md similarity index 100% rename from content/references/rippled-api-methods/validator_list_sites.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validator_list_sites.md diff --git a/content/references/rippled-api-methods/validators.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md similarity index 100% rename from content/references/rippled-api-methods/validators.md rename to content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/validators.md diff --git a/content/references/rippled-api/api-conventions/api-conventions.md b/content/references/rippled-api/api-conventions/api-conventions.md new file mode 100644 index 0000000000..a81dd6a75a --- /dev/null +++ b/content/references/rippled-api/api-conventions/api-conventions.md @@ -0,0 +1,5 @@ +# API Conventions + +This section describes data types and formats of the `rippled` APIs, including JSON-RPC and WebSocket interfaces. + +Some of these data types also appear in higher-level APIs, including the [Data API](data-api.html). diff --git a/content/references/reference-currency.md b/content/references/rippled-api/api-conventions/currency-formatting.md similarity index 100% rename from content/references/reference-currency.md rename to content/references/rippled-api/api-conventions/currency-formatting.md diff --git a/content/references/reference-ledger-format.md b/content/references/rippled-api/ledger-data-formats/ledger-format.md similarity index 100% rename from content/references/reference-ledger-format.md rename to content/references/rippled-api/ledger-data-formats/ledger-format.md diff --git a/content/references/ledger-objects/accountroot.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/accountroot.md similarity index 100% rename from content/references/ledger-objects/accountroot.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/accountroot.md diff --git a/content/references/ledger-objects/amendments.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/amendments.md similarity index 100% rename from content/references/ledger-objects/amendments.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/amendments.md diff --git a/content/references/ledger-objects/check.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/check.md similarity index 100% rename from content/references/ledger-objects/check.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/check.md diff --git a/content/references/ledger-objects/directorynode.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/directorynode.md similarity index 100% rename from content/references/ledger-objects/directorynode.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/directorynode.md diff --git a/content/references/ledger-objects/escrow.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/escrow.md similarity index 100% rename from content/references/ledger-objects/escrow.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/escrow.md diff --git a/content/references/ledger-objects/feesettings.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/feesettings.md similarity index 100% rename from content/references/ledger-objects/feesettings.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/feesettings.md diff --git a/content/references/ledger-objects/ledgerhashes.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/ledgerhashes.md similarity index 100% rename from content/references/ledger-objects/ledgerhashes.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/ledgerhashes.md diff --git a/content/references/ledger-objects/offer.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/offer.md similarity index 100% rename from content/references/ledger-objects/offer.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/offer.md diff --git a/content/references/ledger-objects/paychannel.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/paychannel.md similarity index 100% rename from content/references/ledger-objects/paychannel.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/paychannel.md diff --git a/content/references/ledger-objects/ripplestate.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/ripplestate.md similarity index 100% rename from content/references/ledger-objects/ripplestate.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/ripplestate.md diff --git a/content/references/ledger-objects/signerlist.md b/content/references/rippled-api/ledger-data-formats/ledger-objects/signerlist.md similarity index 100% rename from content/references/ledger-objects/signerlist.md rename to content/references/rippled-api/ledger-data-formats/ledger-objects/signerlist.md diff --git a/content/references/rippled-api-methods/account_channels.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md similarity index 100% rename from content/references/rippled-api-methods/account_channels.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md diff --git a/content/references/rippled-api-methods/account_currencies.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md similarity index 100% rename from content/references/rippled-api-methods/account_currencies.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md diff --git a/content/references/rippled-api-methods/account_info.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md similarity index 100% rename from content/references/rippled-api-methods/account_info.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_info.md diff --git a/content/references/rippled-api-methods/account_lines.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md similarity index 100% rename from content/references/rippled-api-methods/account_lines.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md diff --git a/content/references/rippled-api-methods/account_objects.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md similarity index 100% rename from content/references/rippled-api-methods/account_objects.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md diff --git a/content/references/rippled-api-methods/account_offers.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md similarity index 100% rename from content/references/rippled-api-methods/account_offers.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md diff --git a/content/references/rippled-api-methods/account_tx.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md similarity index 100% rename from content/references/rippled-api-methods/account_tx.md rename to content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md diff --git a/content/references/rippled-api-methods/gateway_balances.md b/content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md similarity index 100% rename from content/references/rippled-api-methods/gateway_balances.md rename to content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md diff --git a/content/references/rippled-api-methods/noripple_check.md b/content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md similarity index 100% rename from content/references/rippled-api-methods/noripple_check.md rename to content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md diff --git a/content/references/rippled-api-methods/ledger.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md similarity index 100% rename from content/references/rippled-api-methods/ledger.md rename to content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md diff --git a/content/references/rippled-api-methods/ledger_closed.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md similarity index 100% rename from content/references/rippled-api-methods/ledger_closed.md rename to content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md diff --git a/content/references/rippled-api-methods/ledger_current.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md similarity index 100% rename from content/references/rippled-api-methods/ledger_current.md rename to content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md diff --git a/content/references/rippled-api-methods/ledger_data.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md similarity index 100% rename from content/references/rippled-api-methods/ledger_data.md rename to content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md diff --git a/content/references/rippled-api-methods/ledger_entry.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md similarity index 100% rename from content/references/rippled-api-methods/ledger_entry.md rename to content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md diff --git a/content/references/rippled-api-methods/book_offers.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md similarity index 100% rename from content/references/rippled-api-methods/book_offers.md rename to content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md diff --git a/content/references/rippled-api-methods/path_find.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/path_find.md similarity index 100% rename from content/references/rippled-api-methods/path_find.md rename to content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/path_find.md diff --git a/content/references/rippled-api-methods/ripple_path_find.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md similarity index 100% rename from content/references/rippled-api-methods/ripple_path_find.md rename to content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md diff --git a/content/references/rippled-api-methods/channel_authorize.md b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md similarity index 100% rename from content/references/rippled-api-methods/channel_authorize.md rename to content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_authorize.md diff --git a/content/references/rippled-api-methods/channel_verify.md b/content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md similarity index 100% rename from content/references/rippled-api-methods/channel_verify.md rename to content/references/rippled-api/public-rippled-methods/payment-channel-methods/channel_verify.md diff --git a/content/references/rippled-api-methods/fee.md b/content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md similarity index 100% rename from content/references/rippled-api-methods/fee.md rename to content/references/rippled-api/public-rippled-methods/server-info-methods/fee.md diff --git a/content/references/rippled-api-methods/server_info.md b/content/references/rippled-api/public-rippled-methods/server-info-methods/server_info.md similarity index 100% rename from content/references/rippled-api-methods/server_info.md rename to content/references/rippled-api/public-rippled-methods/server-info-methods/server_info.md diff --git a/content/references/rippled-api-methods/server_state.md b/content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md similarity index 100% rename from content/references/rippled-api-methods/server_state.md rename to content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md diff --git a/content/references/rippled-api-methods/subscribe.md b/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md similarity index 100% rename from content/references/rippled-api-methods/subscribe.md rename to content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md diff --git a/content/references/rippled-api-methods/unsubscribe.md b/content/references/rippled-api/public-rippled-methods/subscription-methods/unsubscribe.md similarity index 100% rename from content/references/rippled-api-methods/unsubscribe.md rename to content/references/rippled-api/public-rippled-methods/subscription-methods/unsubscribe.md diff --git a/content/references/rippled-api-methods/sign.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/sign.md similarity index 100% rename from content/references/rippled-api-methods/sign.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/sign.md diff --git a/content/references/rippled-api-methods/sign_for.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md similarity index 100% rename from content/references/rippled-api-methods/sign_for.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/sign_for.md diff --git a/content/references/rippled-api-methods/submit.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/submit.md similarity index 100% rename from content/references/rippled-api-methods/submit.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/submit.md diff --git a/content/references/rippled-api-methods/submit_multisigned.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md similarity index 100% rename from content/references/rippled-api-methods/submit_multisigned.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/submit_multisigned.md diff --git a/content/references/rippled-api-methods/transaction_entry.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md similarity index 100% rename from content/references/rippled-api-methods/transaction_entry.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md diff --git a/content/references/rippled-api-methods/tx.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md similarity index 100% rename from content/references/rippled-api-methods/tx.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md diff --git a/content/references/rippled-api-methods/tx_history.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/tx_history.md similarity index 100% rename from content/references/rippled-api-methods/tx_history.md rename to content/references/rippled-api/public-rippled-methods/transaction-methods/tx_history.md diff --git a/content/references/rippled-api-methods/json.md b/content/references/rippled-api/public-rippled-methods/utility-methods/json.md similarity index 100% rename from content/references/rippled-api-methods/json.md rename to content/references/rippled-api/public-rippled-methods/utility-methods/json.md diff --git a/content/references/rippled-api-methods/ping.md b/content/references/rippled-api/public-rippled-methods/utility-methods/ping.md similarity index 100% rename from content/references/rippled-api-methods/ping.md rename to content/references/rippled-api/public-rippled-methods/utility-methods/ping.md diff --git a/content/references/rippled-api-methods/random.md b/content/references/rippled-api/public-rippled-methods/utility-methods/random.md similarity index 100% rename from content/references/rippled-api-methods/random.md rename to content/references/rippled-api/public-rippled-methods/utility-methods/random.md diff --git a/content/references/reference-rippled-api-admin-landing.md b/content/references/rippled-api/rippled-api-admin-landing.md similarity index 100% rename from content/references/reference-rippled-api-admin-landing.md rename to content/references/rippled-api/rippled-api-admin-landing.md diff --git a/content/references/reference-rippled-api-conventions-landing.md b/content/references/rippled-api/rippled-api-conventions-landing.md similarity index 100% rename from content/references/reference-rippled-api-conventions-landing.md rename to content/references/rippled-api/rippled-api-conventions-landing.md diff --git a/content/references/reference-rippled-api-landing.md b/content/references/rippled-api/rippled-api-landing.md similarity index 100% rename from content/references/reference-rippled-api-landing.md rename to content/references/rippled-api/rippled-api-landing.md diff --git a/content/references/reference-rippled-api-ledger-data-format-landing.md b/content/references/rippled-api/rippled-api-ledger-data-format-landing.md similarity index 100% rename from content/references/reference-rippled-api-ledger-data-format-landing.md rename to content/references/rippled-api/rippled-api-ledger-data-format-landing.md diff --git a/content/references/reference-rippled-api-public-landing.md b/content/references/rippled-api/rippled-api-public-landing.md similarity index 100% rename from content/references/reference-rippled-api-public-landing.md rename to content/references/rippled-api/rippled-api-public-landing.md diff --git a/content/references/reference-rippled-api-transaction-format-landing.md b/content/references/rippled-api/rippled-api-transaction-format-landing.md similarity index 100% rename from content/references/reference-rippled-api-transaction-format-landing.md rename to content/references/rippled-api/rippled-api-transaction-format-landing.md diff --git a/content/references/reference-rippled.md b/content/references/rippled-api/rippled.md similarity index 99% rename from content/references/reference-rippled.md rename to content/references/rippled-api/rippled.md index ec60e5e1cd..ed0f1252f7 100755 --- a/content/references/reference-rippled.md +++ b/content/references/rippled-api/rippled.md @@ -1,4 +1,4 @@ -# rippled +# rippled API The core peer-to-peer server that manages the XRP Ledger is called `rippled`. Each `rippled` server connects to a network of peers, relays cryptographically signed transactions, and maintains a local copy of the complete shared global ledger. The source code for `rippled` is written in C++, and is [available on GitHub under an open-source license](https://github.com/ripple/rippled). diff --git a/content/references/reference-transaction-format.md b/content/references/rippled-api/transaction-formats/transaction-format.md similarity index 100% rename from content/references/reference-transaction-format.md rename to content/references/rippled-api/transaction-formats/transaction-format.md diff --git a/content/references/transactions/accountset.md b/content/references/rippled-api/transaction-formats/transaction-types/accountset.md similarity index 100% rename from content/references/transactions/accountset.md rename to content/references/rippled-api/transaction-formats/transaction-types/accountset.md diff --git a/content/references/transactions/checkcancel.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md similarity index 100% rename from content/references/transactions/checkcancel.md rename to content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md diff --git a/content/references/transactions/checkcash.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md similarity index 100% rename from content/references/transactions/checkcash.md rename to content/references/rippled-api/transaction-formats/transaction-types/checkcash.md diff --git a/content/references/transactions/checkcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md similarity index 100% rename from content/references/transactions/checkcreate.md rename to content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md diff --git a/content/references/transactions/enableamendment.md b/content/references/rippled-api/transaction-formats/transaction-types/enableamendment.md similarity index 100% rename from content/references/transactions/enableamendment.md rename to content/references/rippled-api/transaction-formats/transaction-types/enableamendment.md diff --git a/content/references/transactions/escrowcancel.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md similarity index 100% rename from content/references/transactions/escrowcancel.md rename to content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md diff --git a/content/references/transactions/escrowcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md similarity index 100% rename from content/references/transactions/escrowcreate.md rename to content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md diff --git a/content/references/transactions/escrowfinish.md b/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md similarity index 100% rename from content/references/transactions/escrowfinish.md rename to content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md diff --git a/content/references/transactions/offercancel.md b/content/references/rippled-api/transaction-formats/transaction-types/offercancel.md similarity index 100% rename from content/references/transactions/offercancel.md rename to content/references/rippled-api/transaction-formats/transaction-types/offercancel.md diff --git a/content/references/transactions/offercreate.md b/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md similarity index 100% rename from content/references/transactions/offercreate.md rename to content/references/rippled-api/transaction-formats/transaction-types/offercreate.md diff --git a/content/references/transactions/payment.md b/content/references/rippled-api/transaction-formats/transaction-types/payment.md similarity index 100% rename from content/references/transactions/payment.md rename to content/references/rippled-api/transaction-formats/transaction-types/payment.md diff --git a/content/references/transactions/paymentchannelclaim.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md similarity index 100% rename from content/references/transactions/paymentchannelclaim.md rename to content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md diff --git a/content/references/transactions/paymentchannelcreate.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md similarity index 100% rename from content/references/transactions/paymentchannelcreate.md rename to content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md diff --git a/content/references/transactions/paymentchannelfund.md b/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md similarity index 100% rename from content/references/transactions/paymentchannelfund.md rename to content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md diff --git a/content/references/transactions/setfee.md b/content/references/rippled-api/transaction-formats/transaction-types/setfee.md similarity index 100% rename from content/references/transactions/setfee.md rename to content/references/rippled-api/transaction-formats/transaction-types/setfee.md diff --git a/content/references/transactions/setregularkey.md b/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md similarity index 100% rename from content/references/transactions/setregularkey.md rename to content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md diff --git a/content/references/transactions/signerlistset.md b/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md similarity index 100% rename from content/references/transactions/signerlistset.md rename to content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md diff --git a/content/references/transactions/trustset.md b/content/references/rippled-api/transaction-formats/transaction-types/trustset.md similarity index 100% rename from content/references/transactions/trustset.md rename to content/references/rippled-api/transaction-formats/transaction-types/trustset.md diff --git a/content/use-cases/use-case-listing-xrp.md b/content/use-cases/listing-xrp.md similarity index 100% rename from content/use-cases/use-case-listing-xrp.md rename to content/use-cases/listing-xrp.md diff --git a/dactyl-config.yml b/dactyl-config.yml index 6f8aec286f..4df141f5ac 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -385,217 +385,207 @@ pages: # run a validator, run in stand-alone mode, set up private peers, run in # a cluster, capacity planning +# References ------------------------------------------------------------------- - # - name: References - # funnel: Docs - # doc_type: References - # template: template-landing-references.html - # html: landing-references.html - # sidebar: disabled - # blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses. - # targets: - # - local - # - # - name: rippled API - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # template: template-landing-children.html - # html: reference-rippled-api.html - # targets: - # - local - # - # - name: rippled API Public Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # blurb: Get data from the XRP Ledger and submit transactions using these public API methods. - # html: reference-rippled-public.html - # template: template-landing-children.html - # targets: - # - local - # - # - name: Ledger Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Ledger Methods - # template: template-landing-children.html - # html: reference-rippled-public-ledger-methods.html - # targets: - # - local - # - # - md: rippled-api-methods/ledger_closed.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Ledger Methods - # targets: - # - local - # - # - md: rippled-api-methods/ledger_current.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Ledger Methods - # targets: - # - local - # - # - md: rippled-api-methods/ledger_data.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Ledger Methods - # targets: - # - local - # - # - name: Account Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Account Methods - # template: template-landing-children.html - # html: reference-rippled-public-account-methods.html - # targets: - # - local - # - # - md: rippled-api-methods/account_channels.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Account Methods - # targets: - # - local - # - # - md: rippled-api-methods/account_info.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Account Methods - # targets: - # - local - # - # - name: Transaction Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Public Methods - # subcategory: Transaction Methods - # template: template-landing-children.html - # html: reference-rippled-public-tx-methods.html - # targets: - # - local - # - # - name: rippled API Admin Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Admin Methods - # blurb: Administer a rippled server with these admin API methods. - # html: reference-rippled-admin.html - # template: template-landing-children.html - # targets: - # - local - # - # - name: Server Control Methods - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Admin Methods - # subcategory: Server Control Methods - # html: reference-rippled-admin-server-control-methods.html - # template: template-landing-children.html - # targets: - # - local - # - # - md: rippled-api-methods/ledger_accept.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: rippled API Admin Methods - # subcategory: Server Control Methods - # targets: - # - local - # - # - md: reference-transaction-format.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: Transaction Format - # blurb: A transaction is the only way to modify the XRP Ledger. Get details about its required format. - # targets: - # - local - # - # - name: Transaction Common Fields #TODO: replace with real md file - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: Transaction Format - # html: reference-rippled-transactions-common-fields.html - # targets: - # - local - # - # - name: Transaction Types #TODO: replace with real md file - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: Transaction Format - # html: reference-rippled-transaction-types.html - # targets: - # - local - # - # - name: Transaction Results #TODO: replace with real md file - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: Transaction Format - # html: reference-rippled-transaction-results.html - # targets: - # - local - # - # - md: reference-ledger-format.md - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: Ledger Data Format - # blurb: Learn about individual data objects that comprise the XRP Ledger's shared state. - # targets: - # - local - # - # - name: API Conventions #TODO: replace with real md file - # funnel: Docs - # doc_type: References - # supercategory: rippled API - # category: API Conventions - # html: reference-rippled-api-conventions.html - # blurb: Lorem ipsum dolor sit amet... - # targets: - # - local - # - # - md: reference-data-api.md - # funnel: Docs - # doc_type: References - # category: Data API - # blurb: Access more XRP Ledger data, including transaction history and analytics. - # curated_anchors: - # - name: Methods - # anchor: "#api-method-reference" - # - name: API Conventions - # anchor: "#api-conventions" - # targets: - # - local - # + - name: References + funnel: Docs + doc_type: References + template: template-landing-references.html + html: references.html + sidebar: disabled + blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses. + targets: + - local + + # rippled API -------------------------------------------------------------- + + - name: rippled API # TODO: md landing page? + html: reference-rippled-api.html + funnel: Docs + doc_type: References + supercategory: rippled API + template: template-landing-children.html + blurb: Use the rippled API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger. + targets: + - local + + - md: references/rippled-api/api-conventions/api-conventions.md + html: api-conventions.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: API Conventions + template: template-landing-children.html + targets: + - local + + # TODO: Basic Data Types, Ripple Epoch Time + + - md: references/rippled-api/api-conventions/currency-formatting.md + html: currency-formatting.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: API Conventions + targets: + - local + + # TODO: rippled Server States, Error Formatting + + - name: Public rippled Methods #TODO: possible md landing content? + html: public-rippled-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + blurb: Get data from the XRP Ledger and submit transactions using these public API methods. + template: template-landing-children.html + targets: + - local + + - name: Account Methods #TODO: possible md landing content? + html: account-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Account Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/public-rippled-methods/account-methods/account_channels.md + html: account_channels.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Account Methods + targets: + - local + + # TODO: 8 other account methods + + - name: Ledger Methods #TODO: possible md landing content? + html: ledger-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Ledger Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/public-rippled-methods/ledger-methods/ledger.md + html: ledger.html # Watch carefully for clashes w/ this filename + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Ledger Methods + targets: + - local + + # TODO: 5 other ledger methods + + - name: Transaction Methods #TODO: possible md landing content? + html: transaction-methods.html # watch for clashes w/ this filename + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Transaction Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/public-rippled-methods/transaction-methods/sign.md + html: sign.html # watch for clashes w/ this filename + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Transaction Methods + template: template-landing-children.html + targets: + - local + + # TODO: 6 other transaction methods + + - name: Path and Order Book Methods #TODO: possible md landing content? + html: path-and-order-book-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Path and Order Book Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md + html: book_offers.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Path and Order Book Methods + targets: + - local + + # TODO: 2 other Path and Order Book methods + + # TODO: subcategory landings and method pages for: + # - Payment Channel Methods (2) + # - Subscription Methods (2) + # - Server Info Methods (3) + # - Utility Methods (3) + + - name: Admin rippled Methods #TODO: possible md landing content? + html: admin-rippled-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Admin rippled Methods + blurb: Administer a rippled server with these admin API methods. + template: template-landing-children.html + targets: + - local + + - name: Key Generation Methods #TODO: possible md landing content? + html: key-generation-methods.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Key Generation Methods + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md + html: validation_create.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Public rippled Methods + subcategory: Key Generation Methods + targets: + - local + + # TODO: Subcategory landings and pages for: + # - Logging and Data Management Methods (5) + # - Server Control Methods (4) + # - Status and Debugging Messages (8) + + + # --------------- end "rippled API" section -------------------------------- + + # # Temporarily commented out to make building the dev portal faster # - name: RippleAPI Reference # name is required for remote-sourced files # md: https://raw.githubusercontent.com/ripple/ripple-lib/0.21.0/docs/index.md - # html: reference-rippleapi.html + # html: rippleapi-reference.html # funnel: Docs # doc_type: References # category: RippleAPI for JavaScript @@ -612,7 +602,24 @@ pages: # - add_version # targets: # - local - # + + # # Temporarily commented out to make building the dev portal faster + # - md: references/data-api.md + # funnel: Docs + # doc_type: References + # category: Data API + # blurb: Access more XRP Ledger data, including transaction history and analytics. + # curated_anchors: + # - name: Methods + # anchor: "#api-method-reference" + # - name: API Conventions + # anchor: "#api-conventions" + # targets: + # - local + + +# --------------- end "Docs" section ------------------------------------------- +# Use Cases -------------------------------------------------------------------- - md: use-cases/use-cases.md html: use-cases.html funnel: Use Cases @@ -620,83 +627,85 @@ pages: - buttonize targets: - local - # - # - md: tutorial-listing-xrp.md # TODO: split up and rename? - # funnel: Use Cases - # targets: - # - local - # - # - md: use-case-listing-xrp.md - # funnel: Use Cases - # template: template-use-case.html - # useful_background: - # - concept-xrp-ledger-intro.html - # - tutorial-reliable-transaction-submission.html - # - concept-money.html - # targets: - # - local - # - # - md: dev-tools.md - # funnel: Dev Tools - # filters: - # - buttonize - # targets: - # - local - # - # - name: RPC Tool - # funnel: Dev Tools - # html: xrp-ledger-rpc-tool.html - # targets: - # - local - # template: template-xrp-ledger-rpc-tool.html - # - # - name: WebSocket API Tool - # funnel: Dev Tools - # template: template-ripple-api-tool.html - # html: websocket-api-tool.html - # targets: - # - local - # - # - name: Data API v2 Tool - # funnel: Dev Tools - # html: data-api-v2-tool.html - # methods_js: js/apitool-methods-data_v2.js - # rest_host: https://data.ripple.com - # doc_page: reference-data-api.html - # sidebar: custom - # targets: - # - local - # template: template-rest-api-tool.html - # - # - name: ripple.txt Validator - # funnel: Dev Tools - # html: ripple-txt-validator.html - # targets: - # - local - # template: template-ripple-txt-validator.html - # - # - name: XRP Test Net Faucet - # funnel: Dev Tools - # html: xrp-test-net-faucet.html - # targets: - # - local - # template: template-test-net.html - # - # - md: news.md - # funnel: News - # targets: - # - local - # - # - md: reference-amendments.md # TODO: rename to news-amendments.md - # funnel: News - # targets: - # - local + + - md: use-cases/listing-xrp.md + html: listing-xrp.html + funnel: Use Cases + template: template-use-case.html + useful_background: + - xrp-ledger-overview.html + - reliable-transaction-submission.html + - xrp.html + targets: + - local + + +# Dev Tools -------------------------------------------------------------------- + - md: dev-tools/dev-tools.md + funnel: Dev Tools + filters: + - buttonize + targets: + - local + + - name: RPC Tool + funnel: Dev Tools + html: xrp-ledger-rpc-tool.html + targets: + - local + template: template-xrp-ledger-rpc-tool.html + + - name: WebSocket API Tool + funnel: Dev Tools + template: template-websocket-api-tool.html + html: websocket-api-tool.html + targets: + - local + + - name: Data API v2 Tool + funnel: Dev Tools + html: data-api-v2-tool.html + methods_js: js/apitool-methods-data_v2.js + rest_host: https://data.ripple.com + doc_page: data-api.html + sidebar: custom + targets: + - local + template: template-rest-api-tool.html + + - name: ripple.txt Validator + funnel: Dev Tools + html: ripple-txt-validator.html + targets: + - local + template: template-ripple-txt-validator.html + + - name: XRP Test Net Faucet + funnel: Dev Tools + html: xrp-test-net-faucet.html + targets: + - local + template: template-test-net.html + +# News ------------------------------------------------------------------------- + + - md: news/news.md + funnel: News + targets: + - local + + - md: news/known-amendments.md + funnel: News + targets: + - local + + # Note: other "News" links (Release Notes, eventually Network Status) + # are external to this site ignore_anchors_in: - data-api-v2-tool.html - - ripple-api-tool.html - - tool-jsonrpc.html + - websocket-api-tool.html #Sometimes, a link is not really problematic, but the link checker detects it # as such and the easiest solution is to ignore it. diff --git a/tool/template-ripple-api-tool.html b/tool/template-websocket-api-tool.html similarity index 100% rename from tool/template-ripple-api-tool.html rename to tool/template-websocket-api-tool.html