mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
Basic file layout of references (ledger formats, transaction formats)
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Admin `rippled` Methods
|
||||
# Admin rippled Methods
|
||||
|
||||
Communicate directly with a `rippled` server using these admin API methods.
|
||||
|
||||
@@ -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)**
|
||||
<!--{# TODO: provide overview text of what this content is all about #}-->
|
||||
@@ -1,4 +1,4 @@
|
||||
# Public `rippled` Methods
|
||||
# Public rippled Methods
|
||||
|
||||
Communicate directly with a `rippled` server using these public API methods.
|
||||
|
||||
@@ -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.
|
||||
|
||||
<!--{# TODO: Expand this content once we see the content in this section. #}-->
|
||||
@@ -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)**
|
||||
<!--{# TODO: Should this come before Transaction Formats? It seems that you'll need this info to be able to make your first requests -- but once you know it, you won't really be accessing it all the time. #}-->
|
||||
* **[API Conventions](api-conventions.html)**
|
||||
|
||||
Get details about these common conventions used across the `rippled` API.
|
||||
@@ -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)**
|
||||
<!--{# TODO: provide overview text of what this content is all about #}-->
|
||||
|
||||
* **[Transaction Types](x)**
|
||||
* **[Transaction Types](transaction-types.html)**
|
||||
<!--{# TODO: provide overview text of what this content is all about #}-->
|
||||
|
||||
* **[Transaction Results](x)**
|
||||
* **[Transaction Results](transaction-results.html)**
|
||||
<!--{# TODO: provide overview text of what this content is all about #}-->
|
||||
|
||||
<!--{# TODO: This page may need to catch overflow of any doc from https://developers.ripple.com/reference-transaction-format.html that hasn't been moved out to other docs, such as tutorials and more granular reference docs. If yes - need to adjust presentation of links to child pages above because they may look like anchor links to topics on the page and cause confusion. Ideally, we'd provide another page in this hierarchy that reflects the content in the overflow. #}-->
|
||||
@@ -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 --------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user