References general file structure (methods)

content/references/references.md

@@ -1,41 +0,0 @@
-# References
-
-## [`rippled` API Reference](x)
-<!--{# provide link to PDF #}-->
-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.
-<!--{# content populated based on hierarchy and template #}-->
-
-### [Admin `rippled` API Methods](x)
-Communicate directly with a `rippled` server using these admin-only API methods.
-<!--{# content populated based on hierarchy and template #}-->
-
-### [Transaction Formats](x)
-A transaction is the only way to modify the XRP Ledger. Get details about its required format.
-<!--{# content populated based on hierarchy and template #}-->
-
-### [Ledger Data Formats](x)
-Learn about the format of individual ledgers that make up the shared, global XRP Ledger.
-<!--{# content populated based on hierarchy and template #}-->
-
-### [API Conventions](x)
-Get details about these common conventions used across the `rippled` API.
-<!--{# content populated based on hierarchy and template #}-->
-
-
-## Other `rippled` API Interfaces
-Here are a couple of other ways to interface with the `rippled` API.
-
-### [ripple-lib for JavaScript Reference](x)
-<!--{# provide link to PDF #}-->
-Official client library to the XRP Ledger. Available for JavaScript only.
-
-<!--{# content populated based on hierarchy and template #}-->
-
-### [Data API v2 Reference](x)
-<!--{# provide link to PDF #}-->
-Access info about changes to the XRP Ledger, including transaction history and analytics.
-
-<!--{# content populated based on hierarchy and template #}-->

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

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

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
+    -   name: References
-    #     funnel: Docs
+        funnel: Docs
-    #     doc_type: References
+        doc_type: References
-    #     template: template-landing-references.html
+        template: template-landing-references.html
-    #     html: landing-references.html
+        html: references.html
-    #     sidebar: disabled
+        sidebar: disabled
-    #     blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses.
+        blurb: Look up the ins-and-outs of XRP Ledger APIs, including sample requests and responses.
-    #     targets:
+        targets:
-    #         - local
+            - local
-    #
+
-    # -   name: rippled API
+    # rippled API --------------------------------------------------------------
-    #     funnel: Docs
+
-    #     doc_type: References
+    -   name: rippled API # TODO: md landing page?
-    #     supercategory: rippled API
+        html: reference-rippled-api.html
-    #     template: template-landing-children.html
+        funnel: Docs
-    #     html: reference-rippled-api.html
+        doc_type: References
-    #     targets:
+        supercategory: rippled API
-    #         - local
+        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.
-    # -   name: rippled API Public Methods
+        targets:
-    #     funnel: Docs
+            - local
-    #     doc_type: References
+
-    #     supercategory: rippled API
+    -   md: references/rippled-api/api-conventions/api-conventions.md
-    #     category: rippled API Public Methods
+        html: api-conventions.html
-    #     blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
+        funnel: Docs
-    #     html: reference-rippled-public.html
+        doc_type: References
-    #     template: template-landing-children.html
+        supercategory: rippled API
-    #     targets:
+        category: API Conventions
-    #         - local
+        template: template-landing-children.html
-    #
+        targets:
-    # -   name: Ledger Methods
+            - local
-    #     funnel: Docs
+
-    #     doc_type: References
+    # TODO: Basic Data Types, Ripple Epoch Time
-    #     supercategory: rippled API
+
-    #     category: rippled API Public Methods
+    -   md: references/rippled-api/api-conventions/currency-formatting.md
-    #     subcategory: Ledger Methods
+        html: currency-formatting.html
-    #     template: template-landing-children.html
+        funnel: Docs
-    #     html: reference-rippled-public-ledger-methods.html
+        doc_type: References
-    #     targets:
+        supercategory: rippled API
-    #         - local
+        category: API Conventions
-    #
+        targets:
-    # -   md: rippled-api-methods/ledger_closed.md
+            - local
-    #     funnel: Docs
+
-    #     doc_type: References
+    # TODO: rippled Server States, Error Formatting
-    #     supercategory: rippled API
+
-    #     category: rippled API Public Methods
+    -   name: Public rippled Methods #TODO: possible md landing content?
-    #     subcategory: Ledger Methods
+        html: public-rippled-methods.html
-    #     targets:
+        funnel: Docs
-    #         - local
+        doc_type: References
-    #
+        supercategory: rippled API
-    # -   md: rippled-api-methods/ledger_current.md
+        category: Public rippled Methods
-    #     funnel: Docs
+        blurb: Get data from the XRP Ledger and submit transactions using these public API methods.
-    #     doc_type: References
+        template: template-landing-children.html
-    #     supercategory: rippled API
+        targets:
-    #     category: rippled API Public Methods
+            - local
-    #     subcategory: Ledger Methods
+
-    #     targets:
+    -   name: Account Methods #TODO: possible md landing content?
-    #         - local
+        html: account-methods.html
-    #
+        funnel: Docs
-    # -   md: rippled-api-methods/ledger_data.md
+        doc_type: References
-    #     funnel: Docs
+        supercategory: rippled API
-    #     doc_type: References
+        category: Public rippled Methods
-    #     supercategory: rippled API
+        subcategory: Account Methods
-    #     category: rippled API Public Methods
+        template: template-landing-children.html
-    #     subcategory: Ledger Methods
+        targets:
-    #     targets:
+            - local
-    #         - local
+
-    #
+    -   md: references/rippled-api/public-rippled-methods/account-methods/account_channels.md
-    # -   name: Account Methods
+        html: account_channels.html
-    #     funnel: Docs
+        funnel: Docs
-    #     doc_type: References
+        doc_type: References
-    #     supercategory: rippled API
+        supercategory: rippled API
-    #     category: rippled API Public Methods
+        category: Public rippled Methods
-    #     subcategory: Account Methods
+        subcategory: Account Methods
-    #     template: template-landing-children.html
+        targets:
-    #     html: reference-rippled-public-account-methods.html
+            - local
-    #     targets:
+
-    #         - local
+    # TODO: 8 other account methods
-    #
+
-    # -   md: rippled-api-methods/account_channels.md
+    -   name: Ledger Methods #TODO: possible md landing content?
-    #     funnel: Docs
+        html: ledger-methods.html
-    #     doc_type: References
+        funnel: Docs
-    #     supercategory: rippled API
+        doc_type: References
-    #     category: rippled API Public Methods
+        supercategory: rippled API
-    #     subcategory: Account Methods
+        category: Public rippled Methods
-    #     targets:
+        subcategory: Ledger Methods
-    #         - local
+        template: template-landing-children.html
-    #
+        targets:
-    # -   md: rippled-api-methods/account_info.md
+            - local
-    #     funnel: Docs
+
-    #     doc_type: References
+    -   md: references/rippled-api/public-rippled-methods/ledger-methods/ledger.md
-    #     supercategory: rippled API
+        html: ledger.html # Watch carefully for clashes w/ this filename
-    #     category: rippled API Public Methods
+        funnel: Docs
-    #     subcategory: Account Methods
+        doc_type: References
-    #     targets:
+        supercategory: rippled API
-    #         - local
+        category: Public rippled Methods
-    #
+        subcategory: Ledger Methods
-    # -   name: Transaction Methods
+        targets:
-    #     funnel: Docs
+            - local
-    #     doc_type: References
+
-    #     supercategory: rippled API
+    # TODO: 5 other ledger methods
-    #     category: rippled API Public Methods
+
-    #     subcategory: Transaction Methods
+    -   name: Transaction Methods #TODO: possible md landing content?
-    #     template: template-landing-children.html
+        html: transaction-methods.html # watch for clashes w/ this filename
-    #     html: reference-rippled-public-tx-methods.html
+        funnel: Docs
-    #     targets:
+        doc_type: References
-    #         - local
+        supercategory: rippled API
-    #
+        category: Public rippled Methods
-    # -   name: rippled API Admin Methods
+        subcategory: Transaction Methods
-    #     funnel: Docs
+        template: template-landing-children.html
-    #     doc_type: References
+        targets:
-    #     supercategory: rippled API
+            - local
-    #     category: rippled API Admin Methods
+
-    #     blurb: Administer a rippled server with these admin API methods.
+    -   md: references/rippled-api/public-rippled-methods/transaction-methods/sign.md
-    #     html: reference-rippled-admin.html
+        html: sign.html # watch for clashes w/ this filename
-    #     template: template-landing-children.html
+        funnel: Docs
-    #     targets:
+        doc_type: References
-    #         - local
+        supercategory: rippled API
-    #
+        category: Public rippled Methods
-    # -   name: Server Control Methods
+        subcategory: Transaction Methods
-    #     funnel: Docs
+        template: template-landing-children.html
-    #     doc_type: References
+        targets:
-    #     supercategory: rippled API
+            - local
-    #     category: rippled API Admin Methods
+
-    #     subcategory: Server Control Methods
+    # TODO: 6 other transaction methods
-    #     html: reference-rippled-admin-server-control-methods.html
+
-    #     template: template-landing-children.html
+    -   name: Path and Order Book Methods #TODO: possible md landing content?
-    #     targets:
+        html: path-and-order-book-methods.html
-    #         - local
+        funnel: Docs
-    #
+        doc_type: References
-    # -   md: rippled-api-methods/ledger_accept.md
+        supercategory: rippled API
-    #     funnel: Docs
+        category: Public rippled Methods
-    #     doc_type: References
+        subcategory: Path and Order Book Methods
-    #     supercategory: rippled API
+        template: template-landing-children.html
-    #     category: rippled API Admin Methods
+        targets:
-    #     subcategory: Server Control Methods
+            - local
-    #     targets:
+
-    #         - local
+    -   md: references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md
-    #
+        html: book_offers.html
-    # -   md: reference-transaction-format.md
+        funnel: Docs
-    #     funnel: Docs
+        doc_type: References
-    #     doc_type: References
+        supercategory: rippled API
-    #     supercategory: rippled API
+        category: Public rippled Methods
-    #     category: Transaction Format
+        subcategory: Path and Order Book Methods
-    #     blurb: A transaction is the only way to modify the XRP Ledger. Get details about its required format.
+        targets:
-    #     targets:
+            - local
-    #         - local
+
-    #
+    # TODO: 2 other Path and Order Book methods
-    # -   name: Transaction Common Fields #TODO: replace with real md file
+
-    #     funnel: Docs
+    # TODO: subcategory landings and method pages for:
-    #     doc_type: References
+    # - Payment Channel Methods (2)
-    #     supercategory: rippled API
+    # - Subscription Methods (2)
-    #     category: Transaction Format
+    # - Server Info Methods (3)
-    #     html: reference-rippled-transactions-common-fields.html
+    # - Utility Methods (3)
-    #     targets:
+
-    #         - local
+    -   name: Admin rippled Methods #TODO: possible md landing content?
-    #
+        html: admin-rippled-methods.html
-    # -   name: Transaction Types #TODO: replace with real md file
+        funnel: Docs
-    #     funnel: Docs
+        doc_type: References
-    #     doc_type: References
+        supercategory: rippled API
-    #     supercategory: rippled API
+        category: Admin rippled Methods
-    #     category: Transaction Format
+        blurb: Administer a rippled server with these admin API methods.
-    #     html: reference-rippled-transaction-types.html
+        template: template-landing-children.html
-    #     targets:
+        targets:
-    #         - local
+            - local
-    #
+
-    # -   name: Transaction Results #TODO: replace with real md file
+    -   name: Key Generation Methods #TODO: possible md landing content?
-    #     funnel: Docs
+        html: key-generation-methods.html
-    #     doc_type: References
+        funnel: Docs
-    #     supercategory: rippled API
+        doc_type: References
-    #     category: Transaction Format
+        supercategory: rippled API
-    #     html: reference-rippled-transaction-results.html
+        category: Public rippled Methods
-    #     targets:
+        subcategory: Key Generation Methods
-    #         - local
+        template: template-landing-children.html
-    #
+        targets:
-    # -   md: reference-ledger-format.md
+            - local
-    #     funnel: Docs
+
-    #     doc_type: References
+    -   md: references/rippled-api/admin-rippled-methods/key-generation-methods/validation_create.md
-    #     supercategory: rippled API
+        html: validation_create.html
-    #     category: Ledger Data Format
+        funnel: Docs
-    #     blurb: Learn about individual data objects that comprise the XRP Ledger's shared state.
+        doc_type: References
-    #     targets:
+        supercategory: rippled API
-    #         - local
+        category: Public rippled Methods
-    #
+        subcategory: Key Generation Methods
-    # -   name: API Conventions #TODO: replace with real md file
+        targets:
-    #     funnel: Docs
+            - local
-    #     doc_type: References
+
-    #     supercategory: rippled API
+    # TODO: Subcategory landings and pages for:
-    #     category: API Conventions
+    # - Logging and Data Management Methods (5)
-    #     html: reference-rippled-api-conventions.html
+    # - Server Control Methods (4)
-    #     blurb: Lorem ipsum dolor sit amet...
+    # - Status and Debugging Messages (8)
-    #     targets:
+
-    #         - local
+
-    #
+    # --------------- end "rippled API" section --------------------------------
-    # -   md: reference-data-api.md
+
-    #     funnel: Docs
+    # # Temporarily commented out to make building the dev portal faster
-    #     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: 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?
+    -   md: use-cases/listing-xrp.md
-    #     funnel: Use Cases
+        html: listing-xrp.html
-    #     targets:
+        funnel: Use Cases
-    #         - local
+        template: template-use-case.html
-    #
+        useful_background:
-    # -   md: use-case-listing-xrp.md
+            - xrp-ledger-overview.html
-    #     funnel: Use Cases
+            - reliable-transaction-submission.html
-    #     template: template-use-case.html
+            - xrp.html
-    #     useful_background:
+        targets:
-    #         - concept-xrp-ledger-intro.html
+            - local
-    #         - tutorial-reliable-transaction-submission.html
+
-    #         - concept-money.html
+
-    #     targets:
+# Dev Tools --------------------------------------------------------------------
-    #         - local
+    -   md: dev-tools/dev-tools.md
-    #
+        funnel: Dev Tools
-    # -   md: dev-tools.md
+        filters:
-    #     funnel: Dev Tools
+            - buttonize
-    #     filters:
+        targets:
-    #         - buttonize
+            - local
-    #     targets:
+
-    #         - local
+    -   name: RPC Tool
-    #
+        funnel: Dev Tools
-    # -   name: RPC Tool
+        html: xrp-ledger-rpc-tool.html
-    #     funnel: Dev Tools
+        targets:
-    #     html: xrp-ledger-rpc-tool.html
+            - local
-    #     targets:
+        template: template-xrp-ledger-rpc-tool.html
-    #         - local
+
-    #     template: template-xrp-ledger-rpc-tool.html
+    -   name: WebSocket API Tool
-    #
+        funnel: Dev Tools
-    # -   name: WebSocket API Tool
+        template: template-websocket-api-tool.html
-    #     funnel: Dev Tools
+        html: websocket-api-tool.html
-    #     template: template-ripple-api-tool.html
+        targets:
-    #     html: websocket-api-tool.html
+            - local
-    #     targets:
+
-    #         - local
+    -   name: Data API v2 Tool
-    #
+        funnel: Dev Tools
-    # -   name: Data API v2 Tool
+        html: data-api-v2-tool.html
-    #     funnel: Dev Tools
+        methods_js: js/apitool-methods-data_v2.js
-    #     html: data-api-v2-tool.html
+        rest_host: https://data.ripple.com
-    #     methods_js: js/apitool-methods-data_v2.js
+        doc_page: data-api.html
-    #     rest_host: https://data.ripple.com
+        sidebar: custom
-    #     doc_page: reference-data-api.html
+        targets:
-    #     sidebar: custom
+            - local
-    #     targets:
+        template: template-rest-api-tool.html
-    #         - local
+
-    #     template: template-rest-api-tool.html
+    -   name: ripple.txt Validator
-    #
+        funnel: Dev Tools
-    # -   name: ripple.txt Validator
+        html: ripple-txt-validator.html
-    #     funnel: Dev Tools
+        targets:
-    #     html: ripple-txt-validator.html
+            - local
-    #     targets:
+        template: template-ripple-txt-validator.html
-    #         - local
+
-    #     template: template-ripple-txt-validator.html
+    -   name: XRP Test Net Faucet
-    #
+        funnel: Dev Tools
-    # -   name: XRP Test Net Faucet
+        html: xrp-test-net-faucet.html
-    #     funnel: Dev Tools
+        targets:
-    #     html: xrp-test-net-faucet.html
+            - local
-    #     targets:
+        template: template-test-net.html
-    #         - local
+
-    #     template: template-test-net.html
+# News -------------------------------------------------------------------------
-    #
+
-    # -   md: news.md
+    -   md: news/news.md
-    #     funnel: News
+        funnel: News
-    #     targets:
+        targets:
-    #         - local
+            - local
-    #
+
-    # -   md: reference-amendments.md # TODO: rename to news-amendments.md
+    -   md: news/known-amendments.md
-    #     funnel: News
+        funnel: News
-    #     targets:
+        targets:
-    #         - local
+            - 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
+    - websocket-api-tool.html
-    - tool-jsonrpc.html
 
 #Sometimes, a link is not really problematic, but the link checker detects it
 # as such and the easiest solution is to ignore it.