Added Jeremy's changes

documents/overview.md

@@ -4,25 +4,25 @@ title: Overview
 
 ## Mission
 
-What if anyone in the world could publish a piece of digital content, anyone else in the world could access it, for free or for payment, and that entire system worked without any centralized authority or point of control?
+What if anyone in the world could publish digital content, anyone else in the world could access it, for free or for payment, and that entire system worked without any centralized authority or point of control?
 
-That's the idea behind LBRY.
+That's the mission of LBRY:
 
 <MissionStatement/>
 
-That's a fancy sentence, so here's a plainer one: we just thought it'd be really damn cool if there was a system that stored as much of the world's information as possible, but was owned and controlled by no one.
+That's a fancy sentence, so here's a plainer one: we just thought it'd be really damn cool if there was a system that made discoverable and distributable as much of the world's information as possible, but was owned and controlled by no one.
 
-^1^ In the information theoric sense, i.e. any data. LBRY facilitates distribution of all data, whether it be a video or a spreadsheet.
+^1(#footnote-1)^ In the information theoric sense, i.e. any data. LBRY facilitates distribution of all data, whether it be a video or a spreadsheet.
 
-^2^ Accessible anywhere in the world on any internet-connected device.
+^2(#footnote-2)^ Accessible anywhere in the world on any internet-connected device.
 
-^3^ Not controlled by any one person, party or authority.
+^3(#footnote-3)^ Not controlled by any one person, party or authority.
 
-^4^ Resistant to censorship or attempts to control; impervious to attacks or disruptions.
+^4(#footnote-4)^ Resistant to censorship or attempts to control; impervious to attacks or disruptions.
 
-^5^ In the Pareto sense, with regards to the production and distribution of information (i.e. digital information is both created and distributed in a way that could not be any more efficient from the perspectives of information producers and consumers).
+^5(#footnote-5)^ In the Pareto sense, with regards to the production and distribution of information (i.e. digital information is both created and distributed in a way that could not be any more efficient from the perspectives of information producers and consumers).
 
-^6^ The most complete collection of world’s books, films, art, games, etc. should be available via LBRY.
+^6(#footnote-6)^ The most complete collection of world’s books, films, art, games, etc. should be available via LBRY.
 
 ## Ecosystem Overview
 

modules/markdown-it-sup.js

@@ -0,0 +1,87 @@
+"use strict";
+
+
+
+//  P A C K A G E S
+
+const regexForIds = /\(#.*\)/g;
+const regexForTextBeforeLink = /^.*(?=\()/g;
+const regexForUnescaping = /\\([ \\!"#$%&'()*+,./:;<=>?@[\]^_`{|}~-])/g;
+
+
+
+//  P R O G R A M
+
+function superscript(state, silent) {
+  const max = state.posMax;
+  const start = state.pos;
+  let found;
+  let content;
+  let token;
+
+  if (state.src.charCodeAt(start) !== 0x5E/* ^ */) return false;
+  if (silent) return false; // do not run pairs in validation mode
+  if (start + 2 >= max) return false;
+
+  state.pos = start + 1;
+
+  while (state.pos < max) {
+    if (state.src.charCodeAt(state.pos) === 0x5E/* ^ */) {
+      found = true;
+      break;
+    }
+
+    state.md.inline.skipToken(state);
+  }
+
+  if (!found || start + 1 === state.pos) {
+    state.pos = start;
+    return false;
+  }
+
+  content = state.src.slice(start + 1, state.pos);
+
+  // do not allow unescaped spaces/newlines inside
+  if (content.match(/(^|[^\\])(\\\\)*\s/)) {
+    state.pos = start;
+    return false;
+  }
+
+  const supText = content.replace(regexForUnescaping, "$1");
+
+  // found!
+  state.posMax = state.pos;
+  state.pos = start + 1;
+
+  // Earlier we checked !silent, but this implementation does not need it
+  token         = state.push("sup_open", "sup", 1);
+  token.markup  = "^";
+
+  if (content.match(regexForIds)) {
+    const theLink = supText.match(regexForIds)[0].replace("(", "").replace(")", "");
+    token.attrPush([ "id", theLink ]);
+  }
+
+  token         = state.push("text", "", 0);
+
+  if (content.match(regexForIds)) {
+    const theText = supText.match(regexForTextBeforeLink)[0];
+    token.content = theText;
+  } else token.content = supText;
+
+  token         = state.push("sup_close", "sup", -1);
+  token.markup  = "^";
+
+  state.pos = state.posMax + 1;
+  state.posMax = max;
+
+  return true;
+}
+
+
+
+//  E X P O R T
+
+module.exports = exports = function sup_plugin(md) {
+  md.inline.ruler.after("emphasis", "sup", superscript);
+};

package.json

@@ -33,7 +33,6 @@
     "make-promises-safe": "^1.1.0",
     "markdown-it": "^8.4.2",
     "markdown-it-anchor": "^5.0.2",
-    "markdown-it-sup": "^1.0.0",
     "markdown-it-wikilinks": "^1.0.1",
     "nanohtml": "^1.2.4",
     "redis": "^2.8.0",

sass/pages/_page.scss

@@ -224,7 +224,7 @@
     }
   }
 
-  a:not(.__button-black):not(.button):not(.feature-link__title):not(.header-anchor):not(.newsletter-standalone__submit) {
+  a:not(.__button-black):not(.button):not(.feature-link__title):not(.header-anchor):not(.newsletter-standalone__submit):not(.__plain) {
     @include underline($teal, $white);
     color: $teal;
   }

views/pages/page.js

@@ -16,7 +16,7 @@ const numberRegex = /^[0-9]/g;
 const md = require("markdown-it")({
   html: true,
   typographer: true
-}).use(require("markdown-it-sup"))
+}).use(local("modules/markdown-it-sup"))
   .use(require("markdown-it-anchor"), {
     slugify: stringToSlugify => {
       let finalString = stringToSlugify

views/partials/ecosystem.js

@@ -127,29 +127,29 @@ module.exports = exports = class Ecosystem extends Component {
         <h2 class="__title">
           <span data-action="open" data-target="lbrycrd">
             Blockchain
-            <em>The blockchain is "lbrycrd"</em>
+            <em>The foundation of the LBRY protocol</em>
           </span>
 
           <div>
-            <span data-action="open" data-target="applications">Applications</span>
+            <span><a href="https://github.com/lbryio/lbrycrd" title="lbrycrd repo">lbrycrd</a></span>
-            <span data-action="open" data-target="lbry">Data Network</span>
           </div>
         </h2>
 
         <div class="ecosystem__module__details">
-          <p><em>This section assumes "blockchain" already means something to you. If you're totally new, the key problem solved by blockhain is the ability for distributed, disparate entities to all agree on a rivalrous state of affairs (such as account balances or metadata associated with a URL).</em></p>
+          <p><em>This section assumes "blockchain" already means something to you. If you're totally new, the key problem solved by blockhain is the ability for distributed, disparate entities to all agree on a rivalrous state of affairs. For a more comprehensive introduction to blockchain, try starting [here]</em></p>
 
-          <p>The LBRY blockchain is a public and uses proof-of-work consensus. It is the foundation of the protocol stack.</p>
+          <p>The LBRY blockchain is a public, proof-of-work of work blockchain consensus. It is the foundation of the protocol stack.</p>
 
-          <p>The most salient feature of the LBRY blockchain is the association of a normalized character string with up to 8KB of metadata. This string of characters forms a LBRY URL, e.g.</p>
+          <p>The most salient feature of the LBRY blockchain is the association of a normalized character string with up to 8KB of metadata. This string of characters forms a LBRY URL, e.g. <a href="/tour?url=lbry://hellolbry"><code>lbry://hellolbry</code></a></p>
 
-          <p>The LBRY blockchain contains two parallel [[Merkle Tree]]s, one for transactions (ala Bitcoin) and one for storing LBRY URLs and metadata.</p>
+          <p>The LBRY blockchain contains two parallel [[Merkle Tree]]s, one for transactions (ala Bitcoin) and one for storing LBRY URLs and metadata. This allows LBRY URLs to be trustfully resolved even without a full copy of the blockchain.</p>
 
           <p>Conventionally, this metadata contains information about the content, such as the title and creator, the price (if any), and a unique signature allowing the actual content to be fetched from the data network, the next level in the LBRY stack.</p>
 
           <h3>Additional Resources</h3>
           <ul>
-            <li>See the [Whitepaper]</li>
+            <li>See the [[Whitepaper]] for a more comprehensive introduction to the LBRY blockchain.</li>
+            <li>See the [[Resources]] for documentation about the LBRY blockchain, including its API.</li>
             <li>See [[Naming]] for learning more about LBRY URLs and how they work.</li>
             <li>See [[Identities]] for learning how the LBRY blockchain handles publisher identities.</li>
           </ul>
@@ -164,47 +164,34 @@ module.exports = exports = class Ecosystem extends Component {
         <h2 class="__title">
           <span data-action="open" data-target="lbry">
             Data Network
-            <em>The data network is "lbry"</em>
+            <em>The "nuts and bolts" (fix this) of the LBRY protocol</em>
           </span>
 
           <div>
-            <span data-action="open" data-target="applications">Applications</span>
+            <span><a href="https://github.com/lbryio/lbry" title="lbry repo">lbry</a></span>
-            <span data-action="open" data-target="lbrycrd">Blockchain</span>
+            <span><a href="https://github.com/lbryio/lbryschema" title="lbryschema repo">lbryschema</a></span>
+            <span><a href="https://github.com/lbryio/torba" title="torba repo">torba</a></span>
           </div>
         </h2>
 
         <div class="ecosystem__module__details">
+          <p>While blockchain is the innovation that makes LBRY possible, the Data Network is the layer that actually makes the blockchain <em>useful</em>.</p>
+          <p>The primary component for this level is <a href="https://github.com/lbryio/lbry">lbry</a>, a daemon that:</p>
+
           <ul>
-            <li>
+            <li>Interprets and validates metadata in the LBRY blockchain via [lbryschema].</li>
-              <strong class="__title">lbryschema</strong>
+            <li>Accesses and distributes the data referenced by metadata in the LBRY blockchain via a peer-to-peer network.</li>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
+            <li>Provides wallet functionality via an [[SPV]] wallet ([torba]).</li>
-              <ul>
+            <li>Facilitates building applications by being easily bundable and providing a simple, clean <a href="https://lbry.io/api">API</a> for the LBRY protocol.</li>
-                <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</li>
-                <li>Himenaeos purus facilisi litora suspendisse molestie, cubilia maecenas faucibus vivamus.</li>
-                <li>Nisi sociosqu interdum augue condimentum vivamus, ac leo feugiat.</li>
-                <li>Justo eu neque aenean nec sagittis, cubilia magnis arcu.</li>
-              </ul>
-            </li>
-            <li>
-              <strong class="__title">lbryumx</strong>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
-              <ul>
-                <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</li>
-                <li>Himenaeos purus facilisi litora suspendisse molestie, cubilia maecenas faucibus vivamus.</li>
-                <li>Nisi sociosqu interdum augue condimentum vivamus, ac leo feugiat.</li>
-                <li>Justo eu neque aenean nec sagittis, cubilia magnis arcu.</li>
-              </ul>
-            </li>
           </ul>
+          <p>Unless choosing to re-implement aspects of the LBRY protocol by hand, most applications that interact with the LBRY network will bundle lbry.</p>
 
           <h3>Additional Resources</h3>
           <ul>
-            <li>
+            <li>See the [[Whitepaper]] for a more comprehensive introduction to the LBRY data network.</li>
-              <a href="https://github.com/lbryio/lbryschema" title="lbryschema source code">lbryschema</a>
+            <li>See [[Resources]] for documentation of the LBRY APIs.</li>
-            </li>
+            <li>See [[Whatever]] for learning more about LBRY distributes data.</li>
-            <li>
+            <li>See [[Build]] for learning how to use the daemon to solve your own problem or build your own app!</li>
-              <a href="https://github.com/lbryio/lbryumx" title="lbryumx source code">lbryumx</a>
-            </li>
           </ul>
         </div>
       </div>
@@ -217,46 +204,33 @@ module.exports = exports = class Ecosystem extends Component {
         <h2 class="__title">
           <span data-action="open" data-target="applications">
             Applications
-            <em>LBRY has a lot of applications</em>
+            <em>Browsers, spee.ch, and ∞</em>
           </span>
 
           <div>
-            <span data-action="open" data-target="lbrycrd">Blockchain</span>
+            <span><a href="https://github.com/lbryio/lbry-android" title="Android app repo">android</a></span>
-            <span data-action="open" data-target="lbry">Data Network</span>
+            <span><a href="https://github.com/lbryio/lbry-desktop" title="Desktop app repo">desktop</a></span>
+            <span><a href="https://github.com/lbryio/spee.ch" title="spee.ch repo">spee.ch</a></span>
           </div>
         </h2>
 
         <div class="ecosystem__module__details">
+          <p>Applications are the final level of the LBRY stack, and they represent how most people will actually use LBRY.</p>
+          <p>LBRY Inc. currently releases and maintains three applications:</p>
+
           <ul>
-            <li>
+            <li><a href="https://github.com/lbryio/lbry-desktop">lbry-desktop</a>, a desktop browser for the LBRY network based in React and Electron.</li>
-              <strong class="__title">Desktop</strong>
+            <li><a href="https://github.com/lbryio/lbry-android">lbry-android</a>, an Android browser for the LBRY network in React Native.</li>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
+            <li><a href="https://github.com/lbryio/spee.ch">spee.ch</a>, a web-based viewer and link dump for free LBRY content.</li>
-              </li>
-            <li>
-              <strong class="__title">Mobile</strong>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
-            </li>
-            <li>
-              <strong class="__title">spee.ch</strong>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
-            </li>
-            <li>
-              <strong class="__title">lighthouse</strong>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
-            </li>
-            <li>
-              <strong class="__title">chainquery</strong>
-              <p>Vel nisi hendrerit id tristique congue tortor nisl luctus, vulputate sem ridiculus inceptos et at torquent feugiat, mus cursus lobortis aenean senectus posuere odio. Imperdiet nascetur dapibus eget convallis ante donec iaculis dictumst mi est, venenatis quisque integer etiam justo id aliquet non diam semper erat, blandit quis lectus ac aptent magna cubilia augue laoreet. Mollis luctus pharetra nisl auctor potenti magna penatibus cras, justo lobortis iaculis porta a vel habitasse vulputate, taciti sociis arcu facilisis duis orci aliquam.</p>
-            </li>
           </ul>
 
+          <p>However, the very idea of LBRY is that there's <em>not</em> just one way to interact with the network. Anyone can build on top of LBRY in a permissionless manner. These applications exist to show what's possible and to give new users a user-friendly way to use LBRY.</p>
+
           <h3>Additional Resources</h3>
           <ul>
-            <li><a href="https://github.com/lbryio/lbry-desktop" title="source code for LBRY's desktop apps">Linux, macOS, and Windows apps</a></li>
+            <li>See [[Contribute]] for learning how to contribute to existing LBRY apps.</li>
-            <li><a href="https://github.com/lbryio/lbry-android" title="LBRY Android app source code">Android app</a></li>
+            <li>See [[Something]] for how to set up your own custom instance of spee.ch.</li>
-            <li><a href="https://github.com/lbryio/spee.ch" title="spee.ch source code">spee.ch</a></li>
+            <li>See [[Build]] for learning how to build your own app!</li>
-            <li><a href="https://github.com/lbryio/lighthouse" title="lighthouse source code">lighthouse</a></li>
-            <li><a href="https://github.com/lbryio/chainquery" title="chainquery source code">chainquery</a></li>
           </ul>
         </div>
       </div>

views/partials/edit-link.js

@@ -27,6 +27,10 @@ module.exports = exports = pagePath => {
       githubUrl = `${githubUrl}/views/pages/resources.js`;
       break;
 
+    case "/tour":
+      githubUrl = `${githubUrl}/views/pages/tour.js`;
+      break;
+
     default:
       githubUrl = `${githubUrl}/documents${pagePath}.md`;
       break;

views/partials/mission-statement.js

@@ -12,6 +12,12 @@ const html = require("choo-async/html");
 
 module.exports = exports = () => html`
   <div class="component--mission-statement">
-    <strong class="component--mission-statement__title">Mission Statement</strong> To create a market for accessing and publishing information<sup>1</sup> that is global<sup>2</sup>, decentralized<sup>3</sup>, robust<sup>4</sup>, optimal<sup>5</sup> and complete<sup>6</sup>.
+    <strong class="component--mission-statement__title">Mission Statement</strong>
+    To create a market for accessing and publishing information<sup><a class="__plain" href="#footnote-1" title="First footnote of our mission statement">1</a></sup>
+    that is global<sup><a class="__plain" href="#footnote-2" title="Second footnote of our mission statement">2</a></sup>,
+    decentralized<sup><a class="__plain" href="#footnote-3" title="Third footnote of our mission statement">3</a></sup>,
+    robust<sup><a class="__plain" href="#footnote-4" title="Fourth footnote of our mission statement">4</a></sup>,
+    optimal<sup><a class="__plain" href="#footnote-5" title="Fifth footnote of our mission statement">5</a></sup>
+    and complete<sup><a class="__plain" href="#footnote-6" title="Sixth footnote of our mission statement">6</a></sup>.
   </div>
 `;