livepeer / livepeer/studio

Document Lens+Livepeer SDK

Open
#1,059 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
88
Forks
37
PR merge metrics
No merged PRs in 30d

Description

https://www.notion.so/livepeer/Lens-Integration-e756c036e6c741de97d8e9ef1c351e84#0fd96f1b6a8448f89dca793ee6f90083

Will involve actually dogfooding the SDK for a good guide for users. It is a higher-level documentation on how to use the SDK to mint Lens publications.
- This is different than code documentation, which should be included in livepeer/task-runner#33. It’s meant for a guide like [How to Mint a Video NFT](https://livepeer.com/docs/guides/video-nfts/mint-a-video-nft) but specific for Lens developers.

Definitions of done:
1. Can read through a guide with no previous knowledge about Livepeer, Lens or the SDK and come out with a sample application or just a simple integration with Lens
2. Output integration should be able to create Lens posts and display them as video players

Contributor guide

Open the contributing guide

Research direction

Start with the linked Notion specification and the existing “How to Mint a Video NFT” guide to understand the intended documentation style. Dogfood the SDK while writing a Lens-focused guide; it is done when a reader without prior Livepeer, Lens, or SDK knowledge can create Lens posts and display them as video players.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.