From dff42c9b88392ab8fdf3c0f97010050e0700bf21 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa Date: Fri, 20 Apr 2018 15:35:40 -0700 Subject: [PATCH] some ui content files --- content/dev-tools.md | 26 ++++++ content/docs.md | 60 ++++++++++++++ content/home.md | 180 ++++++++++++++++++++++++++++++++++++++++++ content/news.md | 31 ++++++++ content/references.md | 45 +++++++++++ content/use-cases.md | 33 ++++++++ 6 files changed, 375 insertions(+) create mode 100644 content/dev-tools.md create mode 100644 content/docs.md create mode 100644 content/home.md create mode 100644 content/news.md create mode 100644 content/references.md create mode 100644 content/use-cases.md diff --git a/content/dev-tools.md b/content/dev-tools.md new file mode 100644 index 0000000000..cb7635cef4 --- /dev/null +++ b/content/dev-tools.md @@ -0,0 +1,26 @@ +# XRP Ledger Developer Tools +We provide a set of developer tools to help you test, explore, and validate XRP Ledger API requests and behavior. + +## [XRP Ledger Lookup Tool](x) +Use this JSON-RPC-based debugging tool to print raw information about a XRP Ledger account, transaction, or ledger. + +## [XRP Ledger Test Net](x) +Use the WebSocket and JSON-RPC Test Net endpoints to test software built on the XRP Ledger without using real funds. Generate Test Net credentials and funds for testing purposes. The ledger and balances are reset on a regular basis. + +For information about how to connect your `rippled` test server to the Test Net, see [XXXXX](x). + +## [rippled API WebSocket Tool](x) +Need to see the rippled API in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required. + + +## [Data API v2 Tool](x) +Need to see the Data API v2 in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required. + +## [rippled.txt Validator](x) +Use this tool to verify that your `ripple.txt` is syntactically correct and deployed properly. + +Have an idea for a tool not provided here? [Contact us](mailto:docs@ripple.com) + + \ No newline at end of file diff --git a/content/docs.md b/content/docs.md new file mode 100644 index 0000000000..9b25069d95 --- /dev/null +++ b/content/docs.md @@ -0,0 +1,60 @@ +# XRP Ledger Documentation + +Dive into our documentation and start integrating with the XRP Ledger. + + +## Concepts + +Learn the "what" and "why" behind fundamental aspects of the XRP Ledger. + + + + +## Tutorials + +Get step-by-step guidance to perform common tasks with the XRP Ledger. + + + + +## XRP References + +Look up the ins-and-outs of our APIs, including sample requests and responses. + + + + +------------------------------ + + + +### Get Started + +[Make a call to the rippled API](#) +[Access the XRP Ledger Test Net](#) +[Understand XRP Ledger Concepts](#) + + +### Popular Docs + + + 1. [rippled API Reference](#) + 2. [About the XRP Ledger Reserve](#) + 3. [Manage the `rippled` Server](#) + 4. [ripple-lib API for JavaScript](#) + 5. [About XRP Ledger Transactions](#) + + +### Recently Updated + + + - [Reliable Transaction Submission](#) + - [How to Send a Check](#) + - [Known Amendments](#) + - [Capacity Planning in `rippled.cfg`](#) + - [Stand +-Alone Mode](#) + \ No newline at end of file diff --git a/content/home.md b/content/home.md new file mode 100644 index 0000000000..3e498cea92 --- /dev/null +++ b/content/home.md @@ -0,0 +1,180 @@ +# Learn. Experiment. Integrate. Contribute. + +The [XRP Ledger](#) is built on rippled, an open-source technology that anyone can use. Use the tools provided here to integrate with and contribute to the open source platform. + + +# Take Me to the References + +[rippled API](#) +[ripple-lib for JavaScript](#) +[Data API v2](#) + + +# Get Started + +[Make a call to the rippled API](#) +[Access the XRP Ledger Test Net](#) +[Understand XRP Ledger Concepts](#) + + +# List XRP in Your exchange + +Does your exchange want to list XRP? + +[List XRP](x) + + +# Run `rippled` + +`rippled` is the core server of the XRP Ledger. Anyone can run one. + +[Run `rippled`](x) + + +# Contribute to `rippled` + +Contribute code and bug reports to help improve `rippled`. + +[Contribute Code](x) + + +# Provide Liquidity in the XRP Ledger + +Are you a market maker who wants to provide liquidity in the XRP Ledger? + +[Provide Liquidity](x) + + + +# New and Updated Docs + +[Reliable Transaction Submission](x) +[`rippled` Capacity Planning](x) +[How to Use Checks](x) + + +# Known Amendments + +Amendments provide a way to introduce new features to the decentralized XRP Ledger network without causing disruptions. + +[View Known Amendments]() + + + +# [XRP Ledger: A Decentralized Cryptographic Ledger](x) + +The XRP Ledger is an open source, decentralized cryptographic ledger. It provides a distributed payment system enabling users to transfer value seamlessly around the world. XRP is the native digital asset of the XRP Ledger and is designed to bridge the many different currencies in use worldwide. + +While there are many contributors, Ripple stewards the development of the XRP Ledger and advances XRP as a key contribution to the Internet of Value: a world in which money moves the way information does today. + +[![image caption](img/image.png)](img/image.png) + +## [The Digital Asset for Payments](x) + +XRP is a digital asset native to the XRP Ledger. Being an open source protocol, anyone with a cryptographic key and an internet connection can receive, hold, and send XRP to anyone else. + +[![image caption](img/image.png)](img/image.png) + +## [Censorship-Resistant Transaction Processing](x) + +No single party decides which XRP transactions succeed or fail, and no one can "roll back" a transaction after it completes. + + +[![image caption](img/image.png)](img/image.png) + +## [Fast, Efficient Consensus Algorithm](x) + +The XRP Ledger's consensus algorithm settles transactions in 3 to 5 seconds, processing at a throughput of 1,500 transactions per second. + + +[![image caption](img/image.png)](img/image.png) + +## [Finite XRP Supply](x) + +When the XRP Ledger began, 100 billion XRP were created, and no more XRP will ever be created. (Each XRP is subdivisible down to 6 decimal places.) + + +[![image caption](img/image.png)](img/image.png) + +## [Responsible Software Governance](x) + +A team of full-time, world-class developers at Ripple maintain and continually improve the XRP Ledger's underlying software. + + +[![image caption](img/image.png)](img/image.png) + +## [Secure, Adaptable Cryptography](x) + +The XRP Ledger relies on industry standard digital signature systems like ECDSA (the same scheme used by Bitcoin) but also supports modern algorithms like Ed25519. + + +[![image caption](img/image.png)](img/image.png) + +## [Modern Features for Smart Contracts](x) + +Features like Escrow, Checks, and Payment Channels support cutting-edge financial applications including the Interledger Protocol. + + +[![image caption](img/image.png)](img/image.png) + +## [On-Ledger Centralized Exchange](x) + +The XRP Ledger has a fully-functional accounting system for tracking and trading obligations denominated in any way users want, and an exchange built into the protocol. + +[Learn More](x) + + + +# Built on the XRP Ledger + +Learn about just a few of the types of integrations developers have built on the XRP Ledger. + +## Exchanges & Gateways + +[![exchange icon](img/exchange.png)](img/exchange.png) + +Integrate your Exchange or Gateway with the XRP Ledger to enable your users to buy and sell XRP and issued currencies. + +[Use Case](x) + +## Market Makers + +[![market maker icon](img/market-maker.png)](img/market-maker.png) + +Integrate with the XRP Ledger to place offers algorithmically or through your own trading interface, providing liquidity between different gateways and their users. + +[Use Case](x) + +## Wallets + +[![wallet icon](img/wallet.png)](img/wallet.png) + +Build a wallet app on the XRP Ledger to enable your users to send and trade XRP and other currencies issued by a gateway you trust. + +_Use Case - Coming Soon_ + +Have an idea for a use case not listed here? [Contact us](projectlotus@ripple.com) + + +# Related Projects + +Looking for other Ripple-related projects? + +[![Ripple Client Portal logo](img/rcp-logo.png)](img/rcp-logo.png) + +## [Ripple Client Portal](https://clients.ripple.com/) +[](login required)](https://clients.ripple.com/) + +For financial institutions using Ripple's proprietary solutions to send money globally. + + +[![Interledger logo](img/interledger-logo.png)](img/interledger-logo.png) + +## [Interledger](https://interledger.org/) + +Interledger is an open protocol suite for sending payments across different ledgers. + \ No newline at end of file diff --git a/content/news.md b/content/news.md new file mode 100644 index 0000000000..f3a1161d8b --- /dev/null +++ b/content/news.md @@ -0,0 +1,31 @@ +# XRP Ledger News and Releases + +Get the latest XRP Ledger news and release information. + + + +## Known Amendments + +Amendments provide a way to introduce new features to the decentralized XRP Ledger network without causing disruptions. Get the comprehensive list of [all known amendments](x) and their statuses on the production XRP Ledger. + +## Ripple Dev Blog + +[Visit the Dev Blog](https://ripple.com/category/dev-blog/) for the latest news and stories about the XRP Ledger and `rippled`. + +## Ripple Open Source Project Releases + +[Visit the ripple GitHub repo](https://github.com/ripple) to access open source projects, including `rippled`, `ripple-lib`, and `ripple-libpp`. + +## Interledger + +[Learn about Interledger](https://interledger.org/), an open protocol suite for sending payments across different ledgers. The open architecture and minimal protocol enable interoperability for any value transfer system. + +### Related Resources +[rippled API Reference](x) +[Manage a `rippled` Server](x) +[XRP Test Net](x) + + \ No newline at end of file diff --git a/content/references.md b/content/references.md new file mode 100644 index 0000000000..04ea0e67d8 --- /dev/null +++ b/content/references.md @@ -0,0 +1,45 @@ +# References + +## [`rippled` API Reference](x) + +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. + + +### [Admin `rippled` API Methods](x) +Communicate directly with a `rippled` server using these admin-only API methods. + + +### [Transaction Formats](x) +A transaction is the only way to modify the XRP Ledger. Get details about its required format. + + +### [Ledger Data Formats](x) +Learn about the format of individual ledgers that make up the shared, global XRP Ledger. + + +### [API Conventions](x) +Get details about these common conventions used across the `rippled` API. + + + +## Other `rippled` API Interfaces +Here are a couple of other ways to interface with the `rippled` API. + +### [ripple-lib for JavaScript Reference](x) + +Official client library to the XRP Ledger. Available for JavaScript only. + + + +### [Data API v2 Reference](x) + +Access info about changes to the XRP Ledger, including transaction history and analytics. + + + + \ No newline at end of file diff --git a/content/use-cases.md b/content/use-cases.md new file mode 100644 index 0000000000..3baba4bc64 --- /dev/null +++ b/content/use-cases.md @@ -0,0 +1,33 @@ +# XRP Ledger Use Cases + +Use these roadmaps to walk you, task-by-task, through implementing your use case. + +Here are some of our users' most popular use cases: + +## [List XRP in My Exchange](x) + +Integrate with the XRP Ledger to be able to list XRP in your exchange, enabling your users to deposit and withdraw XRP. + +## [Provide Liquidity in the XRP Ledger](x) + +Integrate with the XRP Ledger to place offers algorithmically or through your own custom trading interface, providing liquidity between different gateways and their users. + +## [Contribute Code to `rippled`](x) + +Help us improve the open source reference server implementation of `rippled`, the server that is the core of the XRP Ledger peer-to-peer network. + +## [Maintain `rippled` Servers](x) + +Learn how to install, run, and maintain a `rippled` server, whether you need a stock server, test server, or robust production validator. + +Want to see a roadmap for a case not listed here? [Contact us](mailto:docs@ripple.com) + +### Related Resources +[Access the XRP Ledger Test Net](x) +[rippled API Reference](x) +[ripple-lib for JavaScript Reference](x) + + \ No newline at end of file