From e9457b60fffed07ba5a842729eae190e724b0b37 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 18 Apr 2018 18:42:32 -0700 Subject: [PATCH] Docs landing; or, MOAR EMOJI --- 5layers.yml | 58 +++++- assets/css/devportal.css | 72 ++++--- assets/css/ripple.css | 11 +- tool/template-5layerindex.html | 314 ++++++++++++++++++++++++++++--- tool/template-landing-docs.html | 4 +- tool/template-page-children.html | 9 +- 6 files changed, 382 insertions(+), 86 deletions(-) diff --git a/5layers.yml b/5layers.yml index cba29641bb..18b504131d 100644 --- a/5layers.yml +++ b/5layers.yml @@ -44,6 +44,10 @@ targets: # Override them with --vars to change which fork/branch to edit. github_forkurl: https://github.com/ripple/ripple-dev-portal github_branch: master + recently_updated: + - tutorial-reliable-transaction-submission.html + - tutorial-checks-send.html + - reference-amendments.html pages: @@ -53,10 +57,6 @@ pages: template: template-landing-docs.html html: landing-docs.html sidebar: disabled - recently_updated: - - tutorial-reliable-transaction-submission.html - - tutorial-checks-send.html - - reference-amendments.html doc_type_blurbs: 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. @@ -72,6 +72,22 @@ pages: targets: - local + - name: Understanding the XRP Ledger + funnel: Docs + doc_type: Concepts + category: Understanding the XRP Ledger + html: concept-xrp-ledger.html + template: template-landing-category.html + targets: + - local + + - md: concept-xrp-ledger-intro.md + funnel: Docs + doc_type: Concepts + category: Understanding the XRP Ledger + targets: + - local + - name: Payment System funnel: Docs doc_type: Concepts @@ -170,6 +186,22 @@ pages: category: Send and Receive Money targets: - local + + - name: Manage the rippled Server + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + template: template-landing-category.html + targets: + - local + + - md: tutorial-rippled-setup.md + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + targets: + - local + - name: References funnel: Docs doc_type: References @@ -274,12 +306,17 @@ pages: targets: - local - - name: Test Empty Category + - md: reference-transaction-format.md funnel: Docs doc_type: References - category: Test Empty Category - html: reference-rippled-conventions.html - template: template-landing-category.html + category: Transaction Format + targets: + - local + + - md: reference-data-api.md + funnel: Docs + doc_type: References + category: Data API targets: - local @@ -290,6 +327,11 @@ pages: targets: - local + - md: tutorial-listing-xrp.md # TODO: split up and rename? + funnel: Use Cases + targets: + - local + - name: Dev Tools funnel: Dev Tools html: dev-tools.html diff --git a/assets/css/devportal.css b/assets/css/devportal.css index 1867bec760..f2f790ed5a 100644 --- a/assets/css/devportal.css +++ b/assets/css/devportal.css @@ -650,33 +650,6 @@ th { line-height: 16px; } -.portal-index ul { - border-top-left-radius: 5px; - border-top-right-radius: 5px; - padding: 0; -} - -.portal-index li { - list-style: outside none none; - padding: 5px; - padding-left: 25px; - text-indent: 20px; -} - -.portal-index li.top { - text-indent: 0; -} - -.portal-index .dev_heading { - text-transform: uppercase; - text-decoration: none; - color: #202020; -} -.portal-index a.dev_heading:hover { - color: #27a2db; - text-decoration: underline; -} - .build-disclaimer { font-size: 10pt; margin: 2em 0; @@ -684,14 +657,6 @@ th { border-top: 1px solid #777; } -.related-projects { - position: absolute; - top: 70px; - right: 15px; - width: 375px; - border: 1px solid #777; - border-radius: 5px; -} .related-projects a { text-decoration: none; } @@ -701,7 +666,6 @@ th { .related-projects h3 { margin: 0; padding: 5px 15px; - border-bottom: 1px dashed #777; } .related-projects .project-name { font-size: 18px; @@ -937,17 +901,19 @@ th { cursor: default; } -.landing-docs .panel-title > a { +.landing .panel-title { font-weight: bold; +} +.landing .panel-title > a { text-decoration: none; } -.landing-docs .curated-links li:first-child { +.landing .curated-links li:first-child { margin-top: 5px; } -.landing-docs .blurb p { - padding: 20px 0; +.landing .blurb { + padding: 20px; } .content p, @@ -955,3 +921,29 @@ th { .content td { line-height: 1.65; } + +.readmore { + display: block; + margin: 15px auto 5px; +} + +.readmore .btn { + font-size: 18px; + transition: 0.5s; +} + + +.hero-emoji { + font-size: 80px; + text-align: center; +} + +.landing section { + padding: 40px 20px; + border-top: 1px solid #aaa; +} + +.landing section:first-child { + padding-top: 0; + border-top-width: 0; +} diff --git a/assets/css/ripple.css b/assets/css/ripple.css index f37120244c..0b0e6403cd 100755 --- a/assets/css/ripple.css +++ b/assets/css/ripple.css @@ -700,7 +700,6 @@ samp { code { padding: 2px 4px; font-size: 90%; - color: #c7254e; background-color: #f9f2f4; border-radius: 4px; } @@ -2082,10 +2081,8 @@ select[multiple].input-lg { background-image: none; border: 1px solid transparent; white-space: nowrap; - padding: 6px 12px; - font-size: 14px; - line-height: 1.42857143; - border-radius: 4px; + padding: 10px 15px; + border-radius: 5px; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; @@ -2164,7 +2161,6 @@ fieldset[disabled] .btn-default.active { .btn-primary { color: #ffffff; background-color: #27a2db; - border-color: #2e5e96; } .btn-primary:hover, .btn-primary:focus, @@ -2172,8 +2168,7 @@ fieldset[disabled] .btn-default.active { .btn-primary.active, .open > .dropdown-toggle.btn-primary { color: #ffffff; - background-color: #285282; - border-color: #204067; + background-color: #0987d7; } .btn-primary:active, .btn-primary.active, diff --git a/tool/template-5layerindex.html b/tool/template-5layerindex.html index 5a63aebafc..18ca2474d8 100644 --- a/tool/template-5layerindex.html +++ b/tool/template-5layerindex.html @@ -10,40 +10,302 @@ {% endblock %} -{% block bodyclasses %}xrp-ledger-dev-portal no-sidebar{% endblock %} +{% block bodyclasses %}landing no-sidebar{% endblock %} {% block breadcrumbs %}{% endblock %} {% block main %} -
-

All Pages

+
+

Learn. Experiment. Integrate. Contribute.

-
-
    - {% for page in pages %} -
  • {{ page.name }}
    • - {% endfor %} +
    +

    The XRP Ledger is built on rippled, an open-source technology that anyone can use. Use the tools and information provided here to integrate with and contribute to the open-source platform.

-
- +
+ +
+
+
+

Take Me to the References

+
+
+
+ +
+
+
+
+ +
+
+
+

Get Started

+
+
+
+ +
+
+
+
+ +
+
+
+

List XRP in Your Exchange

+
+
+

Does your exchange want to list XRP?

+
+ +
+
+
+
+ +
+ +
+ +
+
+
+

Run rippled

+
+
+

rippled is the core server of the XRP Ledger. Anyone can run one.

+
+ +
+
+
+
+ +
+
+
+

Contribute to rippled

+
+
+

Contribute code and bug reports to help improve rippled.

+
+ +
+
+
+
+ +
+
+
+ +

Issue Currency in the XRP Ledger

+
+
+

Are you a potential gateway who wants to issue currency in the XRP Ledger?

+
+ +
+
+
+
+ +
+
+ +
+
+ +
+
+
+

New and Updated Documentation

+
+
+
+
    + {% for link in target.recently_updated %} + {% set linkpage = pages|selectattr("html", "equalto", link)|first %} +
  1. {{linkpage.name}}
    2. + {% endfor %} +
+
+
+
+
+ +
+
+
+

Known Amendments

+
+
+

Amendments introduce new features to the decentralized XRP Ledger without causing disruptions.

+
+ +
+
+
+
+ +
+
+ +
+

XRP Ledger: A decentralized cryptographic ledger

+
+
+

The XRP Ledger is built powered by a network of peer-to-peer servers. It is the home of XRP, a digital asset designed to bridge the many different currencies in use worldwide.

+

Ripple stewards the development of the XRP Ledger, and advances XRP as a key contribution to the Internet of Value: a wordl in which money moves the way information does today.

+
+
+ +
+ +
+
+
+

💯

+

The Best Digital Asset

+

XRP is a digital asset native to the XRP Ledger. Anyone with a cryptographic key and an internet connection can receive, hold, and send XRP to anyone else.

+
+
+
+ +
+
+
+

🙉

+

Censorship-Resistant Transaction Processing

+

No single party decides which XRP transactions succeed or fail, and no one can "roll back" a transaction after it completes.

+
+
+
+ +
+ +
+ +
+
+
+

💨

+

Fast, Efficient Consensus Algorithm

+

The XRP Ledger's consensus algorithm settles transactions in 4 to 5 seconds, processing at a throughput of up to 1500 transactions per second.

+
+
+
+ +
+
+
+

📈

+

Finite XRP Supply

+

When the XRP Ledger began, 100 billion XRP were created, and no more XRP will ever be created.

+
+
+
+ +
+ +
+ +
+
+
+

⚖️

+

Responsible Software Governance

+

A team of full-time, world-class developers at Ripple maintain and continually improve the XRP Ledger's underlying software.

+
+
+
+ +
+
+
+

🔐

+

Secure, Adaptable Cryptography

+

The XRP Ledger relies on industry standard digital signature systems like ECDSA and also supports modern, efficient algorithms like Ed25519.

+
+
+
+ +
+ +
+ +
+
+
+

⚙️

+

Modern Features for Smart Contracts

+

Features like Escrow, Checks, and Payment Channels support cutting-edge financial applications while safety features like Invariant Checks and Amendments provide for stable operation.

+
+
+
+ +
+
+
+

💱

+

On-Ledger Decentralized Exchange

+

The XRP Ledger also has a fully-functional accounting system for tracking and trading obligations denominated in any way users want, and an exchange built into the protocol.

+
+
+
+ +
+ +
+ +
+

Related Projects

+ +
+
+
+

+ + Ripple Client Portal + +

+

For financial institutions using Ripple's proprietary solutions to send money globally.

+
+
+
+ +
+
+
+

+ + Interledger +

+

An open protocol suite for connecting all forms of digital money.

+
+
+
+ +
+ +
+

Full Sitemap (development purposes)

+
+
+ {% include 'template-page-children.html' %} +
+
+
diff --git a/tool/template-landing-docs.html b/tool/template-landing-docs.html index f87f96407c..5f1498e3c6 100644 --- a/tool/template-landing-docs.html +++ b/tool/template-landing-docs.html @@ -3,7 +3,7 @@ {% block sidebar %} {% endblock %} -{% block bodyclasses %}landing-docs {% endblock %} +{% block bodyclasses %}landing{% endblock %} {% block main %}
@@ -105,7 +105,7 @@
    - {% for link in currentpage.recently_updated %} + {% for link in target.recently_updated %} {% set linkpage = pages|selectattr("html", "equalto", link)|first %}
  1. {{linkpage.name}}
    2. {% endfor %} diff --git a/tool/template-page-children.html b/tool/template-page-children.html index 68eb6dc6c2..f08c5c7057 100644 --- a/tool/template-page-children.html +++ b/tool/template-page-children.html @@ -6,7 +6,10 @@ {% endif %} {% if parent_page.funnel is undefined %} - + {% set parent_level = "home" %} + {% set level_2 = "funnel" %} + {% set level_3 = "doc_type" %} + {% set childpages = pages %}{# special case for home #} {% elif parent_page == pages|selectattr("funnel", "equalto", parent_page.funnel)|first %} {% set parent_level = "funnel" %} {% set level_2 = "doc_type" %} @@ -27,7 +30,9 @@ {% endif %} -{% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %} +{% if parent_level != "home" %} + {% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %} +{% endif %}