LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

Fix: make smoothscroll work with markdown links & update broken links (glossary) #234

Merged
Wick merged 5 commits from fix-glossary into master 2019-01-25 19:05:35 +01:00
Conversation 1 Commits 5 Files changed 2 +12 -17
2 changed files with 12 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
app/dist/scripts/app.js vendored
View file

@ -36,13 +36,8 @@ document.querySelectorAll("a[href^='#']").forEach(anchor => {
if (document.getElementById(element)) {
elementOffset = document.getElementById(element).offsetTop - 74;
window.scroll({ top: elementOffset, behavior: "smooth" });
history.pushState({}, "", `#${element}`); // Add hash to URL bar
}
// Add hash to URL bar when sidebar links are clicked
if (
event.target.parentElement.className === "api__toc__item" ||
event.target.parentElement.parentElement.className === "component--glossary-toc"
) history.replaceState({}, "", `#${element}`);
});
NetOpWibby commented 2019-01-25 18:00:59 +01:00 (Migrated from github.com)
Review
Copy link

Does removing this block affect other pages? For example, if I click a glossary link from the Overview page, will the smooth scroll and anchoring happen?

Does removing this block affect other pages? For example, if I click a glossary link from the Overview page, will the smooth scroll and anchoring happen?
NetOpWibby commented 2019-01-25 18:01:40 +01:00 (Migrated from github.com)
Review
Copy link

I'm not sure how to checkout your branch to test myself.

I'm not sure how to checkout your branch to test myself.
NetOpWibby commented 2019-01-25 19:01:15 +01:00 (Migrated from github.com)
Review
Copy link

@Wick ^

@Wick ^
Wick commented 2019-01-25 19:04:46 +01:00 (Migrated from github.com)
Review
Copy link

Tested on the overview page + api page and it smooth scrolls as it should and updates the URL. My reasoning behind the change was that if it manages to successfully find an element to scroll to it can safely be added to browser history.

I noticed a related issue though: that when smooth-scrolling occurs it wont get properly placed in browser history, on current site as well (navigate with the sidebar then click back in the browser).
My latest commit will fix this by changing from history.replaceState to history.pushState for updating browser history.

Let me know if you need anything more :)

Tested on the overview page + api page and it smooth scrolls as it should and updates the URL. My reasoning behind the change was that if it manages to successfully find an element to scroll to it can safely be added to browser history. I noticed a related issue though: that when smooth-scrolling occurs it wont get properly placed in browser history, on current site as well (navigate with the sidebar then click back in the browser). My latest commit will fix this by changing from history.replaceState to history.pushState for updating browser history. Let me know if you need anything more :)
NetOpWibby commented 2019-01-25 19:05:22 +01:00 (Migrated from github.com)
Review
Copy link

Sweet, sounds good to me. Thanks!

Sweet, sounds good to me. Thanks!
});

22
documents/glossary.md
View file

@ -12,7 +12,7 @@ We encourage the submission of changes and additions to this glossary.
A Binary Large Object (BLOB) is a collection of binary data stored as a single entity in a database management system. When files are uploaded to the LBRY peer to peer network, they are broken down into 2MB encrypted blobs which are then shared to other peers.
A [[manifest]] blob is also created to index the multiple content blobs that were created from the file. A [[stream]] is the collection of all these blobs particlar to one published file. See [Encoding](https://spec.lbry.io/#encoding) in the specification.
A [manifest](#manifest) blob is also created to index the multiple content blobs that were created from the file. A [stream](#stream) is the collection of all these blobs particlar to one published file. See [Encoding](https://spec.lbry.io/#encoding) in the specification.
### Block
@ -144,11 +144,11 @@ The currency code for 1 LBRY Credit (defined as 100 000 000 *deweys*).
### lbrycrd
lbrycrd is the authoritative implementation of the LBRY [[blockchain]] protocol. See [the source code](https://github.com/lbryio/lbrycrd), [the API](/api/blockchain), or [the whitepaper](/whitepaper).
lbrycrd is the authoritative implementation of the LBRY [blockchain](#blockchain) protocol. See [the source code](https://github.com/lbryio/lbrycrd), [the API](/api/blockchain), or [the whitepaper](/whitepaper).
### lbry-sdk
An [[SDK]] for the LBRY protocol that can also be used independently. Distributed as a daemon or bundled directly, it contains a set of convenience methods for developing applications, and bundles an [[SPV]] wallet as well as implementation of the data network.
An [SDK](#sdk) for the LBRY protocol that can also be used independently. Distributed as a daemon or bundled directly, it contains a set of convenience methods for developing applications, and bundles an [SPV](#spv) wallet as well as implementation of the data network.
See [the source code](https://github.com/lbryio/lbry) or [the API documentation](/api/sdk).
@ -194,7 +194,7 @@ Main LBRY network and its blockchain. The term is mostly used in comparison to *
### Manifest
A blob that contains information about all the other blobs in its stream (the content blobs), in JSON format. Sometimes referred to as the [[Stream Descriptor (SD) Blob]], this blob lists each of the other blobs in the stream, in order, along with the filename for the content, and the cryptographic key needed to decode the content blobs [[the stream key]]. See [Content Blobs](https://spec.lbry.io/#content-blobs) in the specification.
A blob that contains information about all the other blobs in its stream (the content blobs), in JSON format. Sometimes referred to as the [[Stream Descriptor (SD) Blob]], this blob lists each of the other blobs in the stream, in order, along with the filename for the content, and the cryptographic key needed to decode the content blobs [the stream key](#stream-key). See [Content Blobs](https://spec.lbry.io/#content-blobs) in the specification.
### Main Chain
@ -298,7 +298,7 @@ A compact Turing-incomplete programming language used in transaction *inputs* an
### SDK
An abbreviation for Software Development Kit. [[lbry-sdk]] is an SDK for developing applications that use the LBRY protocol.
An abbreviation for Software Development Kit. [lbry-sdk](#lbry-sdk) is an SDK for developing applications that use the LBRY protocol.
### Secret key
@ -326,7 +326,7 @@ A transaction *output* can be spent only once: when another valid transaction ma
### SPV
SPV is an abbreviation for [[Simplified Payment Verification]].
SPV is an abbreviation for [Simplified Payment Verification](#simplified-payment-verification).
### Stream
@ -334,19 +334,19 @@ Streaming media is multimedia that is constantly received by and presented to an
### Stream Descriptor (SD) Blob
Same as [[manifest]] The initial blob of a stream, it contains encryption information and points to other blobs required for the stream.
Same as [manifest](#manifest) The initial blob of a stream, it contains encryption information and points to other blobs required for the stream.
### Stream Hash
A unique hash for a [[Stream]]. It is the sha384 hash of the file.
A unique hash for a [Stream](#stream). It is the sha384 hash of the file.
### Stream Key
Found in the [[manifest]], this is the cryptographic key needed to decrypt the content blobs of a stream.
Found in the [manifest](#manifest), this is the cryptographic key needed to decrypt the content blobs of a stream.
### Support (Claim Support)
Same as [[Claim Support]]. A support is a wallet send transaction that includes claim information, which results in adding to a claim's effective amount. A tip is a special type of support that is sent from one wallet to another, so that the receiver can send it to their own wallet.
Same as [Claim Support](#claim-support). A support is a wallet send transaction that includes claim information, which results in adding to a claim's effective amount. A tip is a special type of support that is sent from one wallet to another, so that the receiver can send it to their own wallet.
### Takeover Period
@ -362,7 +362,7 @@ A set of parameters used for testing a LBRY network. Testnet is like *mainnet*,
### Torba
An [[SPV]] wallet for the LBRY [[blockchain]]. See the [source code](https://github.com/lbryio/torba).
An [SPV](#spv) wallet for the LBRY [blockchain](#blockchain). See the [source code](https://github.com/lbryio/torba).
### Transaction