diff --git a/5layers.yml b/5layers.yml index 2fcf23c008..c359ce0ce8 100644 --- a/5layers.yml +++ b/5layers.yml @@ -205,8 +205,9 @@ pages: - name: References funnel: Docs doc_type: References - template: template-landing-children.html + template: template-landing-references.html html: landing-references.html + sidebar: disabled targets: - local @@ -224,6 +225,7 @@ pages: 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: @@ -312,11 +314,23 @@ pages: 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 @@ -331,6 +345,53 @@ pages: 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 @@ -338,6 +399,12 @@ pages: 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 @@ -347,6 +414,14 @@ pages: funnel: Docs doc_type: References category: RippleAPI for JavaScript + blurb: Official client library to the XRP Ledger. Available for JavaScript only. + curated_anchors: + - name: Transactions + anchor: "#transaction-overview" + - name: Basic Types + anchor: "#basic-types" + - name: Methods + anchor: "#api-methods" filters: - remove_doctoc - add_version diff --git a/tool/template-landing-docs.html b/tool/template-landing-docs.html index 2e7aa49580..9a39d2405e 100644 --- a/tool/template-landing-docs.html +++ b/tool/template-landing-docs.html @@ -3,9 +3,9 @@ {% block bodyclasses %}landing{% endblock %} {% block main %} -
-

XRP Ledger Documentation

+
+

XRP Ledger Documentation

{{content}}
diff --git a/tool/template-landing-references.html b/tool/template-landing-references.html new file mode 100644 index 0000000000..460c096e69 --- /dev/null +++ b/tool/template-landing-references.html @@ -0,0 +1,84 @@ +{% extends "template-base.html" %} + +{% block bodyclasses %}landing{% endblock %} + +{% block main %} +
+
+

References

+
+
+ +
+ +

rippled API Reference

+
+

Use the rippled API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger.

+
+ +
+ + {% for page in pages|selectattr("supercategory", "equalto", "rippled API")|list %} + {% if loop.index != 1 and page == pages|selectattr("category", "equalto", page.category)|first %} +
+ {#{% set parent_page = pages|selectattr("html", "equalto", "reference-rippled-public.html")|first %}#} + +
+

{{page.blurb}}

+ {% set depth = 1 %} + {% set parent_page = page %} + {% include 'template-page-children.html' %} +
+
+ + {# go to new row after admin methods #} + {% if page.html == "reference-rippled-admin.html" %} +
+
+ {% endif %} + {% endif %} + {% endfor %} + +
+ +
+ +
+ +

Other XRP Ledger Interfaces

+
+

Here are a few other ways to interact with the XRP Ledger.

+
+
+ + {% for page in pages|selectattr("doc_type", "equalto", "References")|selectattr("supercategory", "ne", "rippled API") %} + {% if loop.index != 1 and page == pages|selectattr("category", "equalto", page.category)|first %} +
+ +
+

{{page.blurb}}

+ {% if page.curated_anchors is defined %} + + {% endif %} + + {% set depth = 1 %} + {% set parent_page = page %} + {% include 'template-page-children.html' %} +
+
+ {% endif %} + {% endfor %} + +
+ +
+ +{% endblock %} diff --git a/tool/template-page-children.html b/tool/template-page-children.html index 81ba4134c3..4bdb8c733b 100644 --- a/tool/template-page-children.html +++ b/tool/template-page-children.html @@ -27,7 +27,6 @@ {% else %} {% endif %} - {% if parent_level != "home" %} {% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %} {% endif %}