From b25b46193e271c64e7b35ef53d9f760cfa8f36b5 Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Wed, 13 Feb 2019 12:46:45 -0500 Subject: [PATCH 01/11] video listing --- documents/resources/setup-videos.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 documents/resources/setup-videos.md diff --git a/documents/resources/setup-videos.md b/documents/resources/setup-videos.md new file mode 100644 index 0000000..5608061 --- /dev/null +++ b/documents/resources/setup-videos.md @@ -0,0 +1,16 @@ +# Getting started with LBRY development + +Having trouble with getting your LBRY development environment setup or do you prefer following along with a video? Well you're in luck...we have setup videos for many of projects! + +## Desktop Application +Check out [our video tutorial](https://spee.ch/7da73fc508ffc4ff8b2711e3c3950110430b0c5f/LBRYAppDesign) to get the [Desktop app](https://github.com/lbryio/lbry-desktop) configured to run from source. + + +## Android Application +Check out [our video tutorial](https://spee.ch/e781060bc708247f07afebc02d5f75cfba8e2c4b/video-2018-10-15053403) to get the [Android app](https://github.com/lbryio/lbry-android) configured to run from source. + +## LBRY SDK +Check out [our video tutorial](https://spee.ch/967f99344308f1e90f0620d91b6c93e4dfb240e0/lbrynet-dev-setup) to get the [LBRY SDK](https://github.com/lbryio/lbry) configured to run from source. + +## LBRY Blockchain +Check out [our video tutorial](https://spee.ch/5803b66dca7707584b36fe6b644f278fc39d1adf/intro-to-LBRYcrd) to get the [LBRY Blockchain](https://github.com/lbryio/lbrycrd) configured to run from source. -- 2.45.2 From 849ca14511862791b96d1f85e6c1d2f02cae7d2f Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Wed, 13 Feb 2019 12:49:04 -0500 Subject: [PATCH 02/11] add setup videos link --- documents/resources.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documents/resources.md b/documents/resources.md index eb29270..8ed68c0 100644 --- a/documents/resources.md +++ b/documents/resources.md @@ -6,6 +6,7 @@ title: Resources ## Additional Resources +- [Developer Setup Videos](/resources/setup-videos) - [LBRY Glossary](/glossary) - [LBRY Merkle Claim Trie](/resources/claimtrie) - [LBRY Consensus Algorithm](/resources/consensus) -- 2.45.2 From 1a45a3f5e415cd072d7ae0e46c389325d87074b4 Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Wed, 13 Feb 2019 12:54:38 -0500 Subject: [PATCH 03/11] add setup videos link Not sure if we want to link to the page, or directly to the video. Figured the page is easier in case the links change, but it is an extra click. --- documents/contribute.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documents/contribute.md b/documents/contribute.md index 5d495dd..ce6c7bb 100644 --- a/documents/contribute.md +++ b/documents/contribute.md @@ -20,8 +20,8 @@ If you want to contribute to LBRY, there's definitely something for you! The fir | Component | Language (Toolset) | What Is It --- | --- | --- -| [lbrycrd](https://github.com/lbryio/lbrycrd) | C++ | A full node for the LBRY blockchain, including a standalone wallet. Used by miners and some applications. Most consumer applications do not bundle [[lbrycrd]] directly, and instead bundle [[lbry-sdk]]. -| [lbry-sdk](https://github.com/lbryio/lbry) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet ([[torba]]), and contains an implementation of the LBRY data network. | +| [lbrycrd](https://github.com/lbryio/lbrycrd) | C++ | A full node for the LBRY blockchain, including a standalone wallet. Used by miners and some applications. Most consumer applications do not bundle [[lbrycrd]] directly, and instead bundle [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). +| [lbry-sdk](https://github.com/lbryio/lbry) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet ([[torba]]), and contains an implementation of the LBRY data network. [Setup video tutorial available](/resources/setup-videos). | | [torba](https://github.com/lbryio/torba) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]]. | | [wallet server](https://github.com/lbryio/lbry/tree/master/lbrynet/extras/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. | [schema](https://github.com/lbryio/lbry/tree/master/lbrynet/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. @@ -29,10 +29,10 @@ If you want to contribute to LBRY, there's definitely something for you! The fir ### Official Applications | Application | Language (Toolset) | What Is It --- | --- | --- -| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. | -| [lbry-android](https://github.com/lbryio/lbry-android) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]]. +| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). | +| [lbry-android](https://github.com/lbryio/lbry-android) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). | [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]]. -| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. +| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. ### Websites | Domain | Language (Toolset) | What Is It -- 2.45.2 From d9a4028cf0012290a089b2a77b7382e55f04afdf Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Thu, 14 Feb 2019 17:19:54 -0500 Subject: [PATCH 04/11] Update resources.md --- documents/resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/resources.md b/documents/resources.md index 8ed68c0..a0a5c88 100644 --- a/documents/resources.md +++ b/documents/resources.md @@ -6,7 +6,7 @@ title: Resources ## Additional Resources -- [Developer Setup Videos](/resources/setup-videos) +- [Developer Setup Intro Videos](/resources/setup-videos) - [LBRY Glossary](/glossary) - [LBRY Merkle Claim Trie](/resources/claimtrie) - [LBRY Consensus Algorithm](/resources/consensus) -- 2.45.2 From c060cd8f4f1803562a72785633fb5543bd64a139 Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Thu, 14 Feb 2019 17:24:42 -0500 Subject: [PATCH 05/11] add redirects to spee.ch videos --- app/data/redirects.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/data/redirects.json b/app/data/redirects.json index c7c3a7f..49d9145 100644 --- a/app/data/redirects.json +++ b/app/data/redirects.json @@ -9,6 +9,10 @@ "/resources/schema": "/spec#metadata", "/resources/signing-claim": "/resources/claim-signing", "/resources/uri": "/spec#urls", + "/resources/video-lbrysdk": "https://spee.ch/967f99344308f1e90f0620d91b6c93e4dfb240e0/lbrynet-dev-setup", + "/resources/video-lbrycrd": "https://spee.ch/5803b66dca7707584b36fe6b644f278fc39d1adf/intro-to-LBRYcrd", + "/resources/video-lbrydesktop": "https://spee.ch/7da73fc508ffc4ff8b2711e3c3950110430b0c5f/LBRYAppDesign", + "/resources/video-lbryandroid": "https://spee.ch/e781060bc708247f07afebc02d5f75cfba8e2c4b/video-2018-10-15053403", "/tour": "/playground", "/specification": "/spec", "/whitepaper": "/spec" -- 2.45.2 From bcd62f9142106469e05b019178bcda4521a601ad Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Thu, 14 Feb 2019 17:28:43 -0500 Subject: [PATCH 06/11] fix links + wording --- documents/resources/setup-videos.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documents/resources/setup-videos.md b/documents/resources/setup-videos.md index 5608061..0f43340 100644 --- a/documents/resources/setup-videos.md +++ b/documents/resources/setup-videos.md @@ -3,14 +3,14 @@ Having trouble with getting your LBRY development environment setup or do you prefer following along with a video? Well you're in luck...we have setup videos for many of projects! ## Desktop Application -Check out [our video tutorial](https://spee.ch/7da73fc508ffc4ff8b2711e3c3950110430b0c5f/LBRYAppDesign) to get the [Desktop app](https://github.com/lbryio/lbry-desktop) configured to run from source. +Check out [our video tutorial](/resources/video-lbrydesktop) to setup the [Desktop app](https://github.com/lbryio/lbry-desktop) development environment. ## Android Application -Check out [our video tutorial](https://spee.ch/e781060bc708247f07afebc02d5f75cfba8e2c4b/video-2018-10-15053403) to get the [Android app](https://github.com/lbryio/lbry-android) configured to run from source. +Check out [our video tutorial](/resources/video-lbryandroid) to setup the [Android app](https://github.com/lbryio/lbry-android) development environment. ## LBRY SDK -Check out [our video tutorial](https://spee.ch/967f99344308f1e90f0620d91b6c93e4dfb240e0/lbrynet-dev-setup) to get the [LBRY SDK](https://github.com/lbryio/lbry) configured to run from source. +Check out [our video tutorial](/resources/video-lbrysdk) to setup the [LBRY SDK](https://github.com/lbryio/lbry) development environment. ## LBRY Blockchain -Check out [our video tutorial](https://spee.ch/5803b66dca7707584b36fe6b644f278fc39d1adf/intro-to-LBRYcrd) to get the [LBRY Blockchain](https://github.com/lbryio/lbrycrd) configured to run from source. +Check out [our video tutorial](/resources/video-lbrycrd) to setup the [LBRY Blockchain](https://github.com/lbryio/lbrycrd) development environment. -- 2.45.2 From 24a4ac18475c9ef5a0faaf37412c99d8995bfc15 Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Thu, 14 Feb 2019 17:30:51 -0500 Subject: [PATCH 07/11] update links --- documents/contribute.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/documents/contribute.md b/documents/contribute.md index ce6c7bb..d6e04f6 100644 --- a/documents/contribute.md +++ b/documents/contribute.md @@ -18,21 +18,21 @@ If you want to contribute to LBRY, there's definitely something for you! The fir ### Core Protocol Components -| Component | Language (Toolset) | What Is It ---- | --- | --- -| [lbrycrd](https://github.com/lbryio/lbrycrd) | C++ | A full node for the LBRY blockchain, including a standalone wallet. Used by miners and some applications. Most consumer applications do not bundle [[lbrycrd]] directly, and instead bundle [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). -| [lbry-sdk](https://github.com/lbryio/lbry) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet ([[torba]]), and contains an implementation of the LBRY data network. [Setup video tutorial available](/resources/setup-videos). | -| [torba](https://github.com/lbryio/torba) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]]. | -| [wallet server](https://github.com/lbryio/lbry/tree/master/lbrynet/extras/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. -| [schema](https://github.com/lbryio/lbry/tree/master/lbrynet/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. +| Component | Language (Toolset) | What Is It | Intro Video +--- | --- | --- | --- +| [lbrycrd](https://github.com/lbryio/lbrycrd) | C++ | A full node for the LBRY blockchain, including a standalone wallet. Used by miners and some applications. Most consumer applications do not bundle [[lbrycrd]] directly, and instead bundle [[lbry-sdk]]. | [Video](/resources/video-lbrycrd) +| [lbry-sdk](https://github.com/lbryio/lbry) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet ([[torba]]), and contains an implementation of the LBRY data network. | [Video](/resources/video-lbrysdk) +| [torba](https://github.com/lbryio/torba) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]]. +| [wallet server](https://github.com/lbryio/lbry/tree/master/lbrynet/extras/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. | | +| [schema](https://github.com/lbryio/lbry/tree/master/lbrynet/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. | | ### Official Applications -| Application | Language (Toolset) | What Is It ---- | --- | --- -| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). | -| [lbry-android](https://github.com/lbryio/lbry-android) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]]. [Setup video tutorial available](/resources/setup-videos). -| [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]]. -| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. +| Application | Language (Toolset) | What Is It | Intro Video +--- | --- | --- | --- +| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbrydesktop) +| [lbry-android](https://github.com/lbryio/lbry-android) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbryandroid) +| [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]]. | | +| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. | | ### Websites | Domain | Language (Toolset) | What Is It -- 2.45.2 From 7389b312d10a7c7c637d60eb596521d6b291a6d1 Mon Sep 17 00:00:00 2001 From: Mark Date: Thu, 14 Feb 2019 21:42:22 -0500 Subject: [PATCH 08/11] updated applications wording --- documents/partials/overview/applications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/partials/overview/applications.md b/documents/partials/overview/applications.md index 8cdd0ba..d313e58 100644 --- a/documents/partials/overview/applications.md +++ b/documents/partials/overview/applications.md @@ -8,7 +8,7 @@ LBRY Inc. currently releases and maintains three applications: - [LBRY Android](https://github.com/lbryio/lbry-android), an Android browser for the LBRY network in React Native and available in the playstore. - [spee.ch](https://github.com/lbryio/spee.ch), a web-based sharing and organizational app designed for self-hosting. -A central idea of LBRY is that there's _not_ a singular way to interact with the network. Anyone can build on top of LBRY in a permissionless manner. LBRY Inc. maintains open-source applications to show what's possible and to give new users a user-friendly to use the network. +A central idea of LBRY is that there's _not_ a singular way to interact with the network. Anyone can build on top of LBRY in a permissionless manner. LBRY Inc. maintains open-source applications to show what's possible and to give new users a user-friendly experience on the network. ### Additional Resources -- 2.45.2 From 454ceeabb0e295160b6b5780e85c3909600b1863 Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Fri, 15 Feb 2019 11:50:56 -0500 Subject: [PATCH 09/11] add metadata, fix metadata --- app/components/head.js | 28 ++++++-------------- app/views/api.js | 14 +++++----- app/views/redirect.js | 12 +++++++-- config.js | 2 +- documents/build.md | 1 + documents/community.md | 1 + documents/contribute.md | 1 + documents/glossary.md | 3 ++- documents/overview.md | 1 + documents/playground.md | 1 + documents/resources.md | 1 + documents/resources/api-wrappers.md | 5 +++- documents/resources/claim-signing.md | 5 +++- documents/resources/claimtrie.md | 5 +++- documents/resources/consensus.md | 5 +++- documents/resources/daemon-settings.md | 7 +++-- documents/resources/download-overview-new.md | 9 +++++-- documents/resources/download-overview.md | 9 +++++-- documents/resources/encrypt-lbrycrd.md | 5 ++++ documents/resources/regtest-setup.md | 8 ++++-- documents/resources/repository-standards.md | 5 +++- 21 files changed, 84 insertions(+), 44 deletions(-) diff --git a/app/components/head.js b/app/components/head.js index ca0c67b..8d74eb9 100644 --- a/app/components/head.js +++ b/app/components/head.js @@ -9,49 +9,37 @@ import html from "choo/html"; // U T I L S import config from "@root/config"; -let title = ""; - - // E X P O R T export default (state, emit) => { - switch(true) { - case (state.route !== "/" && state.params.wildcard): - title = `${state.params.wildcard.capitalize()} ∙ LBRY ∙ ${config.meta.tagline}`; - break; - case (state.route === "api"): - title = `API ∙ LBRY ∙ ${config.meta.tagline}`; - break; - - default: - title = `LBRY ∙ ${config.meta.tagline}`; - break; - } + const newMetadata = state.lbry; + const description = newMetadata && newMetadata.description ? newMetadata.description : config.meta.description; + const title = newMetadata && newMetadata.title ? newMetadata.title + " - lbry.tech" : "lbry.tech - " + config.meta.tagline; if (state.title !== title) emit(state.events.DOMTITLECHANGE, title); state.page = state.page || { }; - const newMetadata = state.lbry; return html` - ${newMetadata && newMetadata.title ? newMetadata.title : title} + ${title} - + + + - - + diff --git a/app/views/api.js b/app/views/api.js index a06bf46..34fa477 100644 --- a/app/views/api.js +++ b/app/views/api.js @@ -25,13 +25,13 @@ const sdkApi = process.env.NODE_ENV === "development" ? // E X P O R T export default async(state) => { - // How to set custom metadata for this page - // state.lbry = { - // description: "This is the API page for LBRY.tech", - // "og:image": "/assets/media/images/carlsagan2.jpg", - // "og:image:height": 300, - // "og:image:width": 400 - // }; + // below is evil, I just inherited it -- Jeremy + const apilabel = state.params.wildcard == "sdk" ? "SDK" : state.params.wildcard.charAt(0).toLocaleUpperCase() + state.params.wildcard.substring(1); + + state.lbry = { + title: apilabel + " API Documentation", + description: "See API documentation, signatures, and sample calls for the LBRY " + apilabel + " APIs." + }; try { const apiResponse = await parseApiFile(state.params.wildcard); diff --git a/app/views/redirect.js b/app/views/redirect.js index d25daab..07938b0 100644 --- a/app/views/redirect.js +++ b/app/views/redirect.js @@ -30,6 +30,8 @@ export default (state, emit) => { // eslint-disable-line const markdownFile = fs.readFileSync(path, "utf-8"); const markdownFileDetails = fm(markdownFile); + const title = markdownFileDetails.attributes.title; + const description = markdownFileDetails.attributes.description || ""; if (markdownFileDetails.attributes.meta) { const customMetadata = {}; @@ -41,10 +43,16 @@ export default (state, emit) => { // eslint-disable-line } } - // below seems evil + state.lbry = customMetadata; } + // below is evil, I just inherited it -- Jeremy + state.lbry = { + title: title, + description: description + }; + // below should be refactored into components let pageScript = ""; @@ -71,7 +79,7 @@ export default (state, emit) => { // eslint-disable-line
-

${markdownFileDetails.attributes.title}

+

${title}

diff --git a/config.js b/config.js index c5d2d8e..d7e95ec 100644 --- a/config.js +++ b/config.js @@ -13,7 +13,7 @@ module.exports = exports = { }, meta: { color: "#222", - description: "LBRY is a free, open, and community-run digital marketplace. Come check out our documentation and contribute!", + description: "LBRY is a free, open, and community-controlled digital goods marketplace. Learn about technical specifics, how to contribute, API specifications, and much more.", name: "LBRY", tagline: "We came from the future to help you save the Internet", title: "LBRY" diff --git a/documents/build.md b/documents/build.md index aedeec7..ca42e4f 100644 --- a/documents/build.md +++ b/documents/build.md @@ -1,5 +1,6 @@ --- title: Build +description: Learn how to build your own app via LBRY in this comprehensive guide! The future of content freedom begins with you. *patriotic music plays* --- ## THIS IS NOT DONE AT ALL AND IF YOU CONTINUE TO READ IT YOU MENTALLY ASSENT TO COMMITTING AT LEAST ONE CHANGE THAT MAKES IT BETTER diff --git a/documents/community.md b/documents/community.md index bae37c3..4183a11 100644 --- a/documents/community.md +++ b/documents/community.md @@ -1,5 +1,6 @@ --- title: Community +description: Want to talk with other LBRYians? Find out where the LBRY team hangs out. It's not _only_ shady street corners. --- Sometimes we say that the LBRY [[blockchain]] is the foundation of the LBRY protocol, but that's not really true. The foundation of LBRY is the community of people that make it possible. diff --git a/documents/contribute.md b/documents/contribute.md index 5d495dd..eaade15 100644 --- a/documents/contribute.md +++ b/documents/contribute.md @@ -1,5 +1,6 @@ --- title: Contributor's Guide +description: Learn how to be a contributor to core and auxiliary LBRY components in this guide. Everything LBRY builds is open-source, be a part of it! --- ## Welcome to LBRY! diff --git a/documents/glossary.md b/documents/glossary.md index 0f9822e..6aae8a1 100644 --- a/documents/glossary.md +++ b/documents/glossary.md @@ -1,5 +1,6 @@ --- -title: LBRY Glossary +title: Glossary +description: lbry.tech sometimes uses acronyms and fancy words. This glossary converts our jargon into clarity. --- This glossary will help you understand the exact meaning of LBRY and blockchain related terms. diff --git a/documents/overview.md b/documents/overview.md index 6e293e1..0aaa195 100644 --- a/documents/overview.md +++ b/documents/overview.md @@ -1,5 +1,6 @@ --- title: Overview +description: What *is* LBRY? Who *is* Satoshi? In this LBRY technology overview, one of those questions is answered thoroughly. --- ## Mission diff --git a/documents/playground.md b/documents/playground.md index 40dc49d..93620cc 100644 --- a/documents/playground.md +++ b/documents/playground.md @@ -1,5 +1,6 @@ --- title: Playground +description: Learn by doing? In this interactive playground you can use the LBRY network and get a feeling for how it actually works! --- Check out any of the interactive examples to get a feel for the LBRY protocol! diff --git a/documents/resources.md b/documents/resources.md index eb29270..f321e11 100644 --- a/documents/resources.md +++ b/documents/resources.md @@ -1,5 +1,6 @@ --- title: Resources +description: Find the LBRY specification, API documentation, our Contributor's guide, and more in the Resources area. --- diff --git a/documents/resources/api-wrappers.md b/documents/resources/api-wrappers.md index 4399fa1..51a5b76 100644 --- a/documents/resources/api-wrappers.md +++ b/documents/resources/api-wrappers.md @@ -1,4 +1,7 @@ -# API wrappers for the LBRY blockchain and protocol +--- +title: API Wrappers +description: Find LBRYAPI wrappers for your favorite language. +--- This document contains a comprehensive list of all available API wrappers for the LBRY protocol and blockchain. API wrappers allow for easier integration of the LBRY APIs into your codebase. They still require you to run either the [LBRY protocol](https://github.com/lbryio/lbry) or the [LBRY blockchain](https://github.com/lbryio/lbrycrd). diff --git a/documents/resources/claim-signing.md b/documents/resources/claim-signing.md index 449c547..aaeb4e9 100644 --- a/documents/resources/claim-signing.md +++ b/documents/resources/claim-signing.md @@ -1,4 +1,7 @@ -# Signing a claim +--- +title: Claim Signing +description: How does signing a claim (a publish) work in LBRY-land? This page explains in great detail. Seriously great detail. The greatest detail anyone has ever seen! +--- Reilly wants to publish _Terror on the Midway_ to the channel he claimed `lbry://@FleischerSuperman`. He picks the name "terroronthemidway", and fills in the information for the claim: diff --git a/documents/resources/claimtrie.md b/documents/resources/claimtrie.md index 7ca83cf..7c67bf0 100644 --- a/documents/resources/claimtrie.md +++ b/documents/resources/claimtrie.md @@ -1,4 +1,7 @@ -# The Merkle Claim Trie +--- +title: Merkle Claim Trie +description: Publishes to the LBRY network get placed into a Merkle Claim Trie. Learn what that is and why trie is not a typo in this resource article. +--- How the data structure that organizes claims by names works, how proofs are generated/verified and how consensus on the state of the trie is represented. diff --git a/documents/resources/consensus.md b/documents/resources/consensus.md index ef4fde8..147e2f1 100644 --- a/documents/resources/consensus.md +++ b/documents/resources/consensus.md @@ -1,4 +1,7 @@ -# LBRY Consensus Algorithm +--- +title: Consensus Algorithm +description: How does the LBRY blockchain achieve consensus? This resource page will explain. +--- LBRY uses [proof of work](https://en.bitcoin.it/wiki/Proof_of_work) as a consensus mechanism, the same way that Bitcoin does. diff --git a/documents/resources/daemon-settings.md b/documents/resources/daemon-settings.md index 5bf3870..c89846d 100644 --- a/documents/resources/daemon-settings.md +++ b/documents/resources/daemon-settings.md @@ -1,6 +1,9 @@ -# Configurable settings for the LBRY daemon +--- +title: SDK Settings +description: The daemon provided by the LBRY SDK has many settings. This resource lists them all and what they mean. Ready, set, settings! +--- -This document outlines how to configure daemon settings and what options are available. They can be found on the lbry GitHub repository in [conf.py](https://github.com/lbryio/lbry/blob/master/lbrynet/conf.py). +This document outlines how to configure SDK daemon settings and what options are available. They can be found on the lbry GitHub repository in [conf.py](https://github.com/lbryio/lbry/blob/master/lbrynet/conf.py). ## Daemon settings configuration diff --git a/documents/resources/download-overview-new.md b/documents/resources/download-overview-new.md index 89d6534..4186faa 100644 --- a/documents/resources/download-overview-new.md +++ b/documents/resources/download-overview-new.md @@ -1,8 +1,13 @@ -# How To Download Content Using LBRY +--- +title: Content Downloading +description: This resource article walks through the step-by-step process of downloading a piece of content from the LBRY network. +--- + +This resource outlines the step-by-step process of using the LBRY protocol to download something. ## Getting Started -This is the step-by-step process of using LBRY to download something. It spans the three core components of LBRY (blockchain, DHT, blob exchange) and explains the structure of the claim metadata and the blobs that make up a stream. +Downloading spans the three core components of LBRY (blockchain, DHT, blob exchange) and explains the structure of the claim metadata and the blobs that make up a stream. You will need: diff --git a/documents/resources/download-overview.md b/documents/resources/download-overview.md index fa7c75b..d454d6b 100644 --- a/documents/resources/download-overview.md +++ b/documents/resources/download-overview.md @@ -1,8 +1,13 @@ -# How To Download Content Using the LBRY Protocol +--- +title: Content Downloading +description: This resource article walks through the step-by-step process of downloading a piece of content from the LBRY network. +--- + +This resource outlines the step-by-step process of using the LBRY protocol to download something. ## Getting Started -This is the step-by-step process of using the LBRY protocol to download something. It spans the three core components of LBRY (blockchain, DHT, blob exchange) and explains the structure of the claim metadata and the blobs that make up a LBRY stream. +Downloading spans the three core components of LBRY (blockchain, DHT, blob exchange) and explains the structure of the claim metadata and the blobs that make up a LBRY stream. You will need: diff --git a/documents/resources/encrypt-lbrycrd.md b/documents/resources/encrypt-lbrycrd.md index 153c644..9b85ec2 100644 --- a/documents/resources/encrypt-lbrycrd.md +++ b/documents/resources/encrypt-lbrycrd.md @@ -1,3 +1,8 @@ +--- +title: Full Node Encryption +description: Learn how to use encryption with lbrycrd, the full blockchain software for the LBRY network. +--- + *Note: The below instructions are the [LBRYCrd Full Blockchain wallet](https://github.com/lbryio/lbrycrd) and not the default wallet that ships with the LBRY App. We are still working on an encryption solution for this.* You can use `lbrycrd-cli encryptwallet ` to encrypt your wallet. diff --git a/documents/resources/regtest-setup.md b/documents/resources/regtest-setup.md index e8af759..1f11b49 100644 --- a/documents/resources/regtest-setup.md +++ b/documents/resources/regtest-setup.md @@ -1,6 +1,10 @@ -# Regtest Setup +--- +title: Regtest Setup +description: Regtest is a parallel testing network for the LBRY blockchain. Learn how to use it in this resource article. +--- + +## Why Use Regtest -## Why use a regtest server A regtest server provides for a way to instantly generate blocks so that transactions can be instantaneous, which ultimately means no waiting for confirmations from the blockchain. Also, it’s not a problem if you accidentally corrupt your wallet, since no real funds are lost! Delete the files and setup a new one. ## Setup diff --git a/documents/resources/repository-standards.md b/documents/resources/repository-standards.md index 5b309fe..4f5174d 100644 --- a/documents/resources/repository-standards.md +++ b/documents/resources/repository-standards.md @@ -1,4 +1,7 @@ -# LBRY Repository Documentation Standards +--- +title: Repository Documentation Standards +description: All repository documentation at LBRY complies with a single standard, outlined in this resource article. +--- This document outlines the standards for all public, open-source repositories used by LBRY. -- 2.45.2 From 3a76f9990cc3cb092cbf55b07224a32dfcd1642a Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Fri, 15 Feb 2019 11:52:27 -0500 Subject: [PATCH 10/11] add space --- documents/resources/api-wrappers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/resources/api-wrappers.md b/documents/resources/api-wrappers.md index 51a5b76..678f414 100644 --- a/documents/resources/api-wrappers.md +++ b/documents/resources/api-wrappers.md @@ -1,6 +1,6 @@ --- title: API Wrappers -description: Find LBRYAPI wrappers for your favorite language. +description: Find LBRY API wrappers for your favorite language. --- This document contains a comprehensive list of all available API wrappers for the LBRY protocol and blockchain. API wrappers allow for easier integration of the LBRY APIs into your codebase. They still require you to run either the [LBRY protocol](https://github.com/lbryio/lbry) or the [LBRY blockchain](https://github.com/lbryio/lbrycrd). -- 2.45.2 From ca2e2b8b6c55ec2cf0bef6a5a329f0a196b2e517 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?netop=3A//=20=E3=82=A6=E3=82=A7=E3=83=83=E3=83=96?= Date: Fri, 15 Feb 2019 11:40:10 -0600 Subject: [PATCH 11/11] Update head.js --- app/components/head.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/components/head.js b/app/components/head.js index 8d74eb9..ed91fa4 100644 --- a/app/components/head.js +++ b/app/components/head.js @@ -6,14 +6,15 @@ import html from "choo/html"; -// U T I L S +// U T I L import config from "@root/config"; + + // E X P O R T export default (state, emit) => { - const newMetadata = state.lbry; const description = newMetadata && newMetadata.description ? newMetadata.description : config.meta.description; const title = newMetadata && newMetadata.title ? newMetadata.title + " - lbry.tech" : "lbry.tech - " + config.meta.tagline; @@ -21,7 +22,6 @@ export default (state, emit) => { if (state.title !== title) emit(state.events.DOMTITLECHANGE, title); state.page = state.page || { }; - return html` ${title} -- 2.45.2