diff --git a/content/references/rippled-api/rippled-api-admin-landing.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md similarity index 97% rename from content/references/rippled-api/rippled-api-admin-landing.md rename to content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md index 53af72d148..c03ab1afc3 100644 --- a/content/references/rippled-api/rippled-api-admin-landing.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md @@ -1,4 +1,4 @@ -# Admin `rippled` Methods +# Admin rippled Methods Communicate directly with a `rippled` server using these admin API methods. diff --git a/content/references/rippled-api/rippled-api-ledger-data-format-landing.md b/content/references/rippled-api/ledger-data-formats/ledger-data-formats.md similarity index 85% rename from content/references/rippled-api/rippled-api-ledger-data-format-landing.md rename to content/references/rippled-api/ledger-data-formats/ledger-data-formats.md index 4d45fcaf23..a89b3d1264 100644 --- a/content/references/rippled-api/rippled-api-ledger-data-format-landing.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-data-formats.md @@ -1,6 +1,6 @@ -# `rippled` Ledger Data Format +# Ledger Data Formats -Learn about the format of individual ledgers that make up the shared, global XRP Ledger. +{{currentpage.blurb}} * **[Ledger Header](x)** diff --git a/content/references/rippled-api/ledger-data-formats/ledger-format.md b/content/references/rippled-api/ledger-data-formats/ledger-format-old-monolith.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-format.md rename to content/references/rippled-api/ledger-data-formats/ledger-format-old-monolith.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/accountroot.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/accountroot.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/amendments.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/amendments.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/check.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/check.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/directorynode.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/directorynode.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/escrow.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/escrow.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/feesettings.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/feesettings.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/ledgerhashes.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/ledgerhashes.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/offer.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/offer.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/paychannel.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/paychannel.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/ripplestate.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/ripplestate.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-objects/signerlist.md b/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-objects/signerlist.md rename to content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md diff --git a/content/references/rippled-api/rippled-api-public-landing.md b/content/references/rippled-api/public-rippled-methods/public-rippled-methods.md similarity index 98% rename from content/references/rippled-api/rippled-api-public-landing.md rename to content/references/rippled-api/public-rippled-methods/public-rippled-methods.md index 86392eaffb..8c5548b53a 100644 --- a/content/references/rippled-api/rippled-api-public-landing.md +++ b/content/references/rippled-api/public-rippled-methods/public-rippled-methods.md @@ -1,4 +1,4 @@ -# Public `rippled` Methods +# Public rippled Methods Communicate directly with a `rippled` server using these public API methods. diff --git a/content/references/rippled-api/rippled-api-conventions-landing.md b/content/references/rippled-api/rippled-api-conventions-landing.md deleted file mode 100644 index e7ada0fb3c..0000000000 --- a/content/references/rippled-api/rippled-api-conventions-landing.md +++ /dev/null @@ -1,5 +0,0 @@ -# `rippled` API Conventions - -Get details about these common conventions used across the `rippled` API, including error formatting, basic data types, and `rippled` server states. - - diff --git a/content/references/rippled-api/rippled-api-landing.md b/content/references/rippled-api/rippled-api.md similarity index 60% rename from content/references/rippled-api/rippled-api-landing.md rename to content/references/rippled-api/rippled-api.md index c3f4334528..74b51e3f86 100644 --- a/content/references/rippled-api/rippled-api-landing.md +++ b/content/references/rippled-api/rippled-api.md @@ -1,24 +1,23 @@ -# `rippled` API Reference +# rippled API Reference -This section provides the following `rippled` API reference documentation: +{{currentpage.blurb}} -* **[Public `rippled` API Methods](x)** +* **[Public `rippled` API Methods](public-rippled-methods.html)** Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server. -* **[Admin `rippled` API Methods](x)** +* **[Admin `rippled` API Methods](admin-rippled-methods.html)** Admin methods are meant only for trusted server operators and include commands for managing, monitoring, and debugging the server. Think of admin methods as being for the personnel in charge of keeping the server operational. -* **[Transaction Formats](x)** +* **[Transaction Formats](transaction-formats.html)** A transaction is the only way to modify the XRP Ledger. Get details about its required format. -* **[Ledger Data Formats](x)** +* **[Ledger Data Formats](ledger-data-formats.html)** Learn about the format of individual ledgers that make up the shared, global XRP Ledger. -* **[API Conventions](x)** - +* **[API Conventions](api-conventions.html)** Get details about these common conventions used across the `rippled` API. diff --git a/content/references/rippled-api/rippled.md b/content/references/rippled-api/rippled-old-monolith.md similarity index 100% rename from content/references/rippled-api/rippled.md rename to content/references/rippled-api/rippled-old-monolith.md diff --git a/content/references/rippled-api/transaction-formats/transaction-format.md b/content/references/rippled-api/transaction-formats/transaction-format-old-monolith.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-format.md rename to content/references/rippled-api/transaction-formats/transaction-format-old-monolith.md diff --git a/content/references/rippled-api/rippled-api-transaction-format-landing.md b/content/references/rippled-api/transaction-formats/transaction-formats.md similarity index 70% rename from content/references/rippled-api/rippled-api-transaction-format-landing.md rename to content/references/rippled-api/transaction-formats/transaction-formats.md index aa6b1ba3a7..512cb6a650 100644 --- a/content/references/rippled-api/rippled-api-transaction-format-landing.md +++ b/content/references/rippled-api/transaction-formats/transaction-formats.md @@ -1,14 +1,14 @@ -# `rippled` Transaction Formats +# Transaction Formats -A transaction is the only way to modify the XRP Ledger. Get details about its required format. +Transactions are the only way to modify the XRP Ledger. Get details about their required format. -* **[Transaction Common Fields](x)** +* **[Transaction Common Fields](transaction-common-fields.html)** -* **[Transaction Types](x)** +* **[Transaction Types](transaction-types.html)** -* **[Transaction Results](x)** +* **[Transaction Results](transaction-results.html)** diff --git a/dactyl-config.yml b/dactyl-config.yml index 4df141f5ac..1212176bfc 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -399,8 +399,8 @@ pages: # rippled API -------------------------------------------------------------- - - name: rippled API # TODO: md landing page? - html: reference-rippled-api.html + - md: references/rippled-api/rippled-api.md + html: rippled-api.html funnel: Docs doc_type: References supercategory: rippled API @@ -432,7 +432,7 @@ pages: # TODO: rippled Server States, Error Formatting - - name: Public rippled Methods #TODO: possible md landing content? + - md: references/rippled-api/public-rippled-methods/public-rippled-methods.md html: public-rippled-methods.html funnel: Docs doc_type: References @@ -542,7 +542,7 @@ pages: # - Server Info Methods (3) # - Utility Methods (3) - - name: Admin rippled Methods #TODO: possible md landing content? + - md: references/rippled-api/admin-rippled-methods/admin-rippled-methods.md html: admin-rippled-methods.html funnel: Docs doc_type: References @@ -579,6 +579,114 @@ pages: # - Server Control Methods (4) # - Status and Debugging Messages (8) + - md: references/rippled-api/ledger-data-formats/ledger-data-formats.md + html: ledger-data-formats.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Ledger Data Formats + blurb: Learn about individual data objects that comprise the XRP Ledger's shared state. + template: template-landing-children.html + targets: + - local + + - name: Ledger Header #TODO: break off from ledger-format-old-monolith.md file + html: ledger-header.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Ledger Data Formats + targets: + - local + + - name: Ledger Object Types #TODO: break off from ledger-format-old-monolith.md file + html: ledger-object-types.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Ledger Data Formats + subcategory: Ledger Object Types + template: template-landing-children.html + targets: + - local + + - md: references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md + html: accountroot.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Ledger Data Formats + subcategory: Ledger Object Types + template: template-landing-children.html + targets: + - local + + # TODO: 10 other ledger object types + + - md: references/rippled-api/transaction-formats/transaction-formats.md + html: transaction-formats.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + blurb: Transactions are the only way to modify the XRP Ledger. Get details about their required format. + template: template-landing-children.html + targets: + - local + + - name: Transaction Common Fields #TODO: break off from transaction-format-old-monolith.md + html: transaction-common-fields.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + blurb: Learn about individual data objects that comprise the XRP Ledger's shared state. + targets: + - local + + - name: Transaction Types #TODO: pull landing content from transaction-format-old-monolith.md + html: transaction-types.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + subcategory: Transaction Types + targets: + - local + + - md: references/rippled-api/transaction-formats/transaction-types/accountset.md + html: accountset.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + subcategory: Transaction Types + targets: + - local + + # TODO: 17 other transaction types + + - name: Transaction Results #TODO: pull landing content from transaction-format-old-monolith.md + html: transaction-results.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + subcategory: Transaction Results + targets: + - local + + - name: tel Codes #TODO: break off content from transaction-format-old-monolith.md + html: tel-codes.html + funnel: Docs + doc_type: References + supercategory: rippled API + category: Transaction Formats + subcategory: Transaction Results + targets: + - local + + # TODO: 5 other result code classes # --------------- end "rippled API" section --------------------------------