Skip to content

Integrate link checking tool to CI #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: check-links
on:
workflow_dispatch:
push:

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Use Node.js [16.x]
uses: actions/setup-node@v3
with:
node-version: 16.x
- name: Install dependencies
run: yarn
- name: Check markdown links
run: yarn check:links
4 changes: 1 addition & 3 deletions docs/Ecosystem/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@
- **[Relation](https://spark.litprotocol.com/semantic/)**: Web3 native social graph.
- **[Orbis Club](https://orbis.club/)**: A fully decentralized social layer for Web3.
- **[Gather](https://www.gather.town/)**: Virtual spaces for remote collaboration.
- **[Headline](https://viaheadline.xyz/)**: A decentralized publishing platform.
- **[Charmverse](https://www.charmverse.io/)**: Web3-native all-in-one workspace.
- **[P00ls](https://www.p00ls.io/)**: A web3 platform for creators and brands.
- **[Gateway](https://www.mygateway.xyz/home)**: Verifiable credential platform.
- **[Gateway](https://www.mygateway.xyz)**: Verifiable credential platform.
- **[Tempra](https://ethglobal.com/showcase/tempra-xnxf4)**: Decentralized social platform inspired by Snapchat.
- **[Lens](https://lens.xyz/)**: Token-gated content on Lens.
- **[The 402](https://app.the402.xyz/)**: Live-streaming and NFT marketplace.
Expand All @@ -29,7 +28,6 @@
### Infrastructure

- **[BAILOUT](https://ethglobal.com/showcase/bailout-ia6s1?ref=spark.litprotocol.com)**: Securely move assets between EOAs, smart contract wallets, and cold wallets.
- **[Strata Protocol](https://strataprotocol.com/)**: An open-source protocol to launch tokens around a person, project, idea, or collective on Solana.
- **[Key-Recovery](https://github.com/Joseph-Gross/key-recovery)**: Distributed social private key recovery made by the team at [Sling Protocol](https://twitter.com/slingprotocol).
- **[Neya](https://github.com/stefsimion/Site-Neya-2)**: Web3-native 2FA protocol.
- **[EtherMonitor](https://github.com/seetadev/EtherMonitor)**: Tools for traffic incident management.
Expand Down
2 changes: 1 addition & 1 deletion docs/SDK/Explanation/authentication/authSig.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ In the `AuthSig` data structure:
- `signedMessage` is the original message that was signed
- `address` is the public key address that was used to create the signature

You can refer to the `AuthSig` type definition in the [Lit JS SDK V2](https://js-sdk.litprotocol.com/interfaces/auth_browser_src.authsig.html).
You can refer to the `AuthSig` type definition in the [Lit JS SDK V2](https://js-sdk.litprotocol.com/interfaces/types_src.AuthSig.html).

## Obtaining an `AuthSig`

Expand Down
2 changes: 1 addition & 1 deletion docs/SDK/Explanation/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If you already have `lit-js-sdk` in your app, all you need to do is remove the o
import * as LitJsSdk from '@lit-protocol/lit-node-client';
```

If you are using TypeScript, be sure to install the `@lit-protocol/types` package. Check out the list of available packages [here]([https://github.com/LIT-Protocol/js-sdk/tree/master#packages](https://github.com/LIT-Protocol/js-sdk/tree/master#packages)).
If you are using TypeScript, be sure to install the `@lit-protocol/types` package. Check out the list of available packages [here](https://github.com/LIT-Protocol/js-sdk/tree/master#packages).

## Notable Changes

Expand Down
14 changes: 7 additions & 7 deletions docs/ToolsAndExamples/Integrations/bundlrxarweave.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Lit Protocol is powered by the threshold cryptography, we can harness on-chain a

- Request a network signed JWT that provides access to dynamic content behind an on-chain condition

![What is Lit explanation graph](/img/lit_explanation.jpeg)
![What is Lit explanation graph](../../../static/img/lit_explanation.jpeg)

## What can Bundlr do?
[Bundlr](https://docs.bundlr.network/docs/about/introduction) is a decentralized storage scaling platform that increases the number of transactions conducted on Arweave, which is a decentralized storage network that enables you to store data permanently. Bundlr can do 2 main things:

1. Collect multiple layer 2 transactions for 2 minutes, bundle them into a single Arweave layer 1 transaction, and submit the bundle onto Arweave.
2. Allow users to sign with their native key when signing for a transaction, eg. Ethereum and Solana.

![How does Bundlr work diagram](/img/bundlr_explanation.webp)
![How does Bundlr work diagram](../../../static/img/bundlr_explanation.webp)

## How do we utilize both technologies, and why?
Let’s say that you want to share private content with members of your DAO and they hold a given NFT, with Lit Protocol and Bundlr, you can encrypt and store an image that can be viewed by anyone that holds the NFT from the DAO’s collection.
Expand All @@ -40,15 +40,15 @@ In this example, we will be encrypting an image (static content) with access con
There are a lot of APIs in both technologies, but in this example, we will only focus on the essential parts, encrypting the data and uploading to Arweave.


![How to encrypt using Lit and Bundlr](/img/lit_encrypt_bundlr.webp)
![How to encrypt using Lit and Bundlr](../../../static/img/lit_encrypt_bundlr.webp)

### Step 1: Encrypt static content with Lit Protocol

![How to encrypt using Lit and Bundlr highlighting encrypting](/img/lit_encrypt_highlight.webp)
![How to encrypt using Lit and Bundlr highlighting encrypting](../../../static/img/lit_encrypt_highlight.webp)

First, we need to encrypt the static content, in our case, an image. In order to do that, we have to do the following steps:

![How to encrypt using Lit and Bundlr highlighting encrypting](/img/process_of_encrypting_static_content.webp)
![How to encrypt using Lit and Bundlr highlighting encrypting](../../../static/img/process_of_encrypting_static_content.webp)

**Step A:**

Expand All @@ -62,11 +62,11 @@ Turn the static content into a `String` format (you can use the [utilities](http

The symmetricKey is necessary to decrypt content and is meant to be private. Exposing the key to the public means anyone may be able to use it to decrypt private information. Luckily, with Lit Protocol, we can encrypt it and store it in the lit nodes, so that only the person who meets the access control conditions could retrieve the original symmetric key. In order to do this, we will need to pass in the following:

`chain (String)`: ethereum (see other [supported blockchains](https://developer.litprotocol.com/resources/supportedChains))
`chain (String)`: ethereum (see other [supported blockchains](/resources/supportedChains))

`authSig (Object)`: authentication signature, which can be collected from calling await LitJsSdk.checkAndSignAuthMessage({chain}) which will call up your web 3 wallets for you to sign the message

`accessControlConditions (Array)`: we can call up the [Share Modal](https://developer.litprotocol.com/docs/littools/sharemodal/) to obtain it
`accessControlConditions (Array)`: we can call up the [Share Modal](/ToolsAndExamples/Tools/shareModal) to obtain it

**Step C:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ _Estimated time to complete: 1 hour_

## Tech Stack

- [Lit SDK](/SDK/intro) - encrypting & decrypting the input description
- [Lit SDK](/sdk/intro) - encrypting & decrypting the input description
- [Hardhat](https://hardhat.org/) - local Ethereum development environment
- [Ethers.js](https://docs.ethers.io/v5/) - interacting with our deployed NFT smart contract
- [Polygon Mumbai network](https://faucet.polygon.technology/) - where we deploy our NFT smart contract
Expand Down
2 changes: 1 addition & 1 deletion docs/intro/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get started today!

**FOR DEVELOPERS: SDK API DOCUMENTATION**

To start building on Lit, check out the Lit SDK [intro](/SDK/intro.mdx). For an in-depth understanding of the functionality provided, check out the [API docs](https://js-sdk.litprotocol.com/).
To start building on Lit, check out the Lit SDK [intro](/SDK/intro). For an in-depth understanding of the functionality provided, check out the [API docs](https://js-sdk.litprotocol.com/).

For references to the Lit Actions functions which can be accessed inside a Lit Action via the `Lit.Actions` object, check out the [Lit Actions](http://actions-docs.litprotocol.com/) API docs.
:::
Expand Down
7 changes: 3 additions & 4 deletions docs/intro/usecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Some examples of applications that can (and have) been built harnessing this fun

### Web3 Apps with Private Data

Introduce privacy to decentralized applications. Use Lit to securely store private and permissioned data on the open web. To get started with an integration, use our JavaScript [SDK](/SDK/intro).
Introduce privacy to decentralized applications. Use Lit to securely store private and permissioned data on the open web. To get started with an integration, use our JavaScript [SDK](/sdk/intro).

Examples:

Expand All @@ -22,7 +22,6 @@ Examples:
- [Starling Lab](https://github.com/starlinglab/archive-explorer/): Token-gated data archives.
- [Streamr](https://blog.streamr.network/streamr-integrates-lit-protocol/): Private data marketplaces.
- [Gather](https://www.gather.town/): Powering private virtual spaces for your team.
- [Headline](https://viaheadline.xyz/): Publish exclusive content for your web3 community.
- [IPFS](https://litgateway.com/files): Encrypt content for private storage on IPFS.
- [WalletChat.fun](https://lit.walletchat.fun/): Encrypted wallet-to-wallet messaging.
- [Nowhere](https://www.urnowhere.com/): Token-gated metaverse spaces.
Expand All @@ -38,7 +37,7 @@ Use on-chain credentials to gate access to your favorite web2 applications and d

### Unlockable NFTs

Using [HTML NFTs](/ToolsAndExamples/SDKExamples/HTMLNfts), you can create locked content that only owners of the NFT have access to. This includes dynamic content, like websites or metaverse spaces.
Using HTML NFTs, you can create locked content that only owners of the NFT have access to. This includes dynamic content, like websites or metaverse spaces.

Here’s an [example](https://twitter.com/LitProtocol/status/1504630741849853954) using our Lit Genesis Canvas NFT. Only holders can access the private canvas site linked within!

Expand Down Expand Up @@ -74,7 +73,7 @@ Build powerful infrastructure that harnesses the power of Lit!

Example Projects:

- [Yacht Labs](https://yachtlabs.io/blog/yacht-lit-swap): Cross-chain atomic swaps with PKPs and Lit Actions
- [Yacht Labs](https://spark.litprotocol.com/xchain-bridging-yacht-lit-swap/): Cross-chain atomic swaps with PKPs and Lit Actions
- [Curve Labs](https://github.com/Curve-Labs/lit-privacy/tree/main): SDK for building privacy-preserving interactions on-chain
- [MagicWallet](https://github.com/DustilDawn/Magic): One account, multiple seedless wallets
- More coming soon… 👀 —> [build with us](https://discord.com/invite/nm9aBG8z9w)!
Expand Down
2 changes: 1 addition & 1 deletion docs/pkp/toolsAndExamples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 6
## Swap Playground
Uniswap trade interface for Programmable Key Pairs (PKPs).
This is a demo to create actions that developers can copy and paste to use for their own projects. After an action is created, the swap can be executed.
![Lit Swap Interface](/img/lit_swap.png)
![Lit Swap Interface](../../static/img/lit_swap.png)

Check it out here: https://lit-swap-playground.netlify.app/

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/howItWorks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1

**FOR DEVELOPERS: SDK API DOCUMENTATION**

To start building on Lit based on your use case, check out the Lit SDK [here](/SDK/intro.mdx). For an in-depth understanding of the functionality provided, check out the [API docs](https://js-sdk.litprotocol.com/).
To start building on Lit based on your use case, check out the Lit SDK [here](/sdk/intro.mdx). For an in-depth understanding of the functionality provided, check out the [API docs](https://js-sdk.litprotocol.com/).

For references to the Lit Actions functions which can be accessed inside a Lit Action via the `Lit.Actions` object, check out the [Lit Actions](http://actions-docs.litprotocol.com/) API docs.

Expand Down Expand Up @@ -45,7 +45,7 @@ We believe that the marriage of MPC, threshold secret schemes (TSS), and SEV pro

The SDK encrypts your content and uploads the conditions for decryption to each Lit Protocol node. You will need to store the encrypted content in a place of your choosing (IPFS, Arweave, or even somewhere centralized).

When someone wants to access the content the SDK will request a message signature from the user's wallet. The message signature proves that the corresponding wallet meets the conditions (ex. NFT ownership) for decryption. The Lit Protocol nodes will then send down the decryption shares. Collecting responses and combining them above a threshold is included in the functionality of the [Lit JS SDK V2](/SDK/intro).
When someone wants to access the content the SDK will request a message signature from the user's wallet. The message signature proves that the corresponding wallet meets the conditions (ex. NFT ownership) for decryption. The Lit Protocol nodes will then send down the decryption shares. Collecting responses and combining them above a threshold is included in the functionality of the [Lit JS SDK V2](/sdk/intro).

### Dynamic Content - Authorizing access to a resource via JWT[](https://developer.litprotocol.com/Introduction/howItWorks#dynamic-content---authorizing-access-to-a-resource-via-jwt)

Expand Down
1 change: 1 addition & 0 deletions docs/resources/supportedChains.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Don't see a blockchain you want? Fill out this form for EVM chains and we'll ad
- hyperspace
- scrollAlphaTestnet
- zksync
- lineaGoerli
- litprotocol
- solana
- solanaDevnet
Expand Down
3 changes: 1 addition & 2 deletions docs/startHere/usecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ Some examples of applications that can (and have) been built harnessing this fun

### Web3 Apps with Private Data

Introduce privacy to decentralized applications. Use Lit to securely store private and permissioned data on the open web. To get started with an integration, use our JavaScript [SDK](/SDK/intro).
Introduce privacy to decentralized applications. Use Lit to securely store private and permissioned data on the open web. To get started with an integration, use our JavaScript [SDK](/sdk/intro).

Examples:

- [Orbis Club](https://orbis.club/): Enabling “friends-only” content and encrypted messaging.
- [Gather](https://www.gather.town/): Powering private virtual spaces for your team.
- [Headline](https://viaheadline.xyz/): Publish exclusive content for your web3 community.
- [IPFS](https://litgateway.com/files): Encrypt content for private storage on IPFS.
- [WalletChat.fun](https://lit.walletchat.fun/): Encrypted wallet-to-wallet messaging.
- [Nowhere](https://www.urnowhere.com/): Token-gated metaverse spaces.
Expand Down
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

[[redirects]]
from = "/docs/LitTools/JSSDK/intro"
to = "/docs/SDK/intro"
to = "/docs/sdk/intro"
status = 302
force = false

Expand Down
2 changes: 1 addition & 1 deletion not-docs/tutorial-extras/manage-docs-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ module.exports = {

The docs version dropdown appears in your navbar:

![Docs Version Dropdown](/img/tutorial/docsVersionDropdown.png)
![Docs Version Dropdown](../../static/img/tutorial/docsVersionDropdown.png)

## Update an existing version

Expand Down
2 changes: 1 addition & 1 deletion not-docs/tutorial-extras/translate-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ module.exports = {

The locale dropdown now appears in your navbar:

![Locale Dropdown](/img/tutorial/localeDropdown.png)
![Locale Dropdown](../../static/img/tutorial/localeDropdown.png)

## Build your localized site

Expand Down
Loading