Basic file layout of references (ledger formats, transaction formats)

This commit is contained in:
mDuo13
2018-05-03 17:30:29 -07:00
parent 48391ba3d5
commit 7849a66914
21 changed files with 128 additions and 26 deletions

View File

@@ -1,4 +1,4 @@
# Admin `rippled` Methods
# Admin rippled Methods
Communicate directly with a `rippled` server using these admin API methods.

View File

@@ -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 #}-->

View File

@@ -1,4 +1,4 @@
# Public `rippled` Methods
# Public rippled Methods
Communicate directly with a `rippled` server using these public API methods.

View File

@@ -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. #}-->

View File

@@ -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.

View File

@@ -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. #}-->