unlock-protocol / docs Goto Github PK

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency @unlock-protocol/networks to v0.0.16
• fix(deps): update dependency clsx to v2

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency @mdx-js/react to v2

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Here is a list of things/tasks we need to work on in order to ship the new docs:

• Merge smart contract autogenrated docs (by @clemsos )
• css adjustment (#34 )
• #48
• #47
• #42
• #41
• #45
• Tag site for Google and make sure we are not losing any SEO juice (permanent redirects are supported in Docusaurus): GTM-PRCCFV9

Later (post launch):

• #43
• #44

Last paragraph of the page uses the acronym NFP. Should be "NFT?"

Add a button tied to a way to collect the data for voting on the usefulness of pages. Ideally we would be able to leave it off some pages like the Litepaper and Getting Started landing page.

People seem to want to have to enter a number more than zero into an amount field. Review places in the docs where we can be explicit about the fact that it can be zero and Unlock accounts are free. We should really get into some dollars and cents implementation examples.

Remove existing tutorial on old react app repo and add in the tutorial for the new create react app template repo with link to video.

Many discussions have been happening in the Discord Server around this issue. We have some guides but they're not really pulled together and instead just about a single issue. We should think through a more step-by-step approach with an overview of all the things that can be done there. See this document put together by Raul Gonzalez.

https://docs.google.com/document/d/10CUnH_b46ZYZrQoFfsQfMoMQ7cvdXs5BTGuSFlgQNJ8/edit

In this screenshot #38 (comment) , it seems that the Solidity code is not highlighted on the docs.

We need to see how to support it https://docusaurus.io/docs/markdown-features/code-blocks#syntax-highlighting

We should have 3 levels with a clear indication of how deep we are in the nav.

The Unlock contract has both createUpgradeableLockAtVersion and createUpgradeableLock (uses the latest version!).
Both of these take a data argument that includes the settings use for the version to deploy.

The data blob is documented by the initialize function on the PublicLock's specific version: https://docs.unlock-protocol.com/core-protocol/smart-contracts-api/PublicLock#initialize

Let's make sure we link to these, as well as improve the docs for the latest version.

From Discord:

Collab Land bot: Note: When using the ERC-1155 token type, you must enter the token IDs for all tokens in your collection in the token ID section. Token IDs should be separated by one comma, and no spaces.

Yes, need the tokens ID.

Additional Note:
This may be a candidate for a convenience script also.

Move under Introduction and add more linking to relevant sections of the docs.

We're not explicit about what "Timestamps" are this came up in the Discord server see the attached conversation.

We ship several @npmjs module. We should document them all in the docs!

Walkthrough of scaffold-eth-unlock use and link to video

From Paywall/collecting-metadata add reference to locksmith/metadata#user-specific-metadata which was removed temporarily because we temporarily removed the Locksmith folder see #43

Hey @clemsos can we make the generated docs look a bit better?
First, we need to move the Hook interfaces/examples into their own folder (rather than being inside the PublicLock one).
Then, we need to have for both Unlock and PublicLock a "latest" version which has the reference and a folder called Archive that has all of the older versions. This will make things MUCH easier for people who are looking at it.

Ideally we also need to add _category_.json file in each folder so we can easily customize how they look like see syntax there

At the root of the generated folder, we should have this:

{
  "label": "Protocol Reference"
}

need to find a way to redirect so we don't lose the traffic ranking.

when use automation to generate document, it seems render versioning into different pages, this might be able to fix with this solution:
https://docusaurus.io/docs/versioning

@searchableguy says:

I started the openAPI spec file to document the APIs. Need to finish that with whatever APIs we want to publicise. Can be done later as well if not important.

POAP.xyz has trademarked "POAP" and we need to remove mention of it OR ask explicit permission.

https://unlock-protocol.com/guides/how-to-do-poaps-with-unlock/

Our introduction doesn't provide clear actionable items for users.

This was provided as feedback from multiple users who wanted to use paywall or look up contract documentation. They had to look under tools which was not clear to them.

Users who aren't familiar with unlock also get confused by the word paywall.

Stripe introduction docs page

Liveblocks

For now main cards would be

1. Paywall - used for embedding checkout in any page.
2. Contract documentation
3. Dashboard
4. Examples & templates
5. Identity or Oauth (SIWE)
6. Get started

We should have a list of all the things each page should have. Metadata headers title, description, share image, human readable links and where to put those.

Our page on the subgraphs misses some of the latest ones: https://docs.unlock-protocol.com/tools/subgraph (Goerli, Celo... etc)

need to match the marketing site style

Moved from #61 because it required a DNS update.

@julien51 can you please add this to the DNS.

Adding in the content for easy copying

google-site-verification=58aD0fqi59jWWKRbfvmg-GBBDMpYGKjEcpZqT4j2z6Y

The contributions guide needs to be more inline with our current workflow.

@clemsos recently changed how the ABI modules package works. We should reflect it in the docs.

See https://search.google.com/test/rich-results

Depends: #120

We continue to see this specific use case. Usually the person comes in and out asking as they make it through the steps. Here is a good thread where Julien had an opportunity spell the steps out. We should have a "flow" style tutorial that includes all the steps and links to relevant existing documentation.

1:10 PM] MercX: Hi guys, new here. Im at the creator dashboard and need a bit of help. I am an artist and not much of a coder. I need help locking a specific web page on my website to only people who hold my NFT collection. Anyone know where I should start documentation wise?
[1:11 PM] MercX: ty in advance!
@mercx
Hi guys, new here. Im at the creator dashboard and need a bit of help. I am an artist and not much of a coder. I need help locking a specific web page on my website to only people who hold my NFT collection. Anyone know where I should start documentation wise?
[1:18 PM] Julien | Ʉnlock: Yes! What CMS do you use for your website?
[1:19 PM] MercX: I use cPanel to host the specific webpage in question
[1:19 PM] MercX: but my landing page is webflow
[1:39 PM] MercX: i dont know if that answers the question lol
@mercx
Hi guys, new here. Im at the creator dashboard and need a bit of help. I am an artist and not much of a coder. I need help locking a specific web page on my website to only people who hold my NFT collection. Anyone know where I should start documentation wise?
[1:52 PM] Angela | Ʉnlock: If you want to lock your Webflow landing page https://docs.unlock-protocol.com/move-to-guides/plugins-and-integrations/#webflow. If you want to use the Paywall to lock content in your website https://docs.unlock-protocol.com/tools/paywall/. It's pretty step by step in the section called "Adding a Lock to Web Page" but if you have trouble knowing exactly where to put it then let me know.
Paywall | Unlock Protocol
The paywall is a web application that provides a user interface allowing people to purchase keys to given locks and subsequently trigger certain behavior based on visitors having keys at the time of page visit. It can be embedded on any web page or inside web views. It also supports WalletConnect which means that any Ethereum wallet can connect ...
Plugins and Integrations | Unlock Protocol
An overview of existing and in progress integrations.
[1:52 PM] MercX: THJANK YOU
NEW
[5:56 PM] MercX: ok, after reading through, I'm a little confused how this would use my existing NFT collection as a key to the locked page (edited)
[5:57 PM] MercX: I am not an html/css/js master. So any help would be greatly appreciated.
[6:00 PM] MercX: so i dont need to lock my webflow page,
just my content page
August 2, 2022
[12:53 AM] Julien | Ʉnlock: @mercx There are 3 steps:
[12:54 AM] Julien | Ʉnlock: 1. deploy a lock
[12:54 AM] Julien | Ʉnlock: 2. Hook the lock to your existing NFT: https://unlock-protocol.com/blog/bring-your-own-nft
[12:54 AM] Julien | Ʉnlock: 3. Add the lock to your content/webpage.
[12:54 AM] Julien | Ʉnlock: You mentioned cpanel, but I am not sure this is a content management system. Are you editing the HTML/CSS/JS manually?
[1:20 AM] MercX: Yes I am editing the lock page manually
[1:24 AM] Julien | Ʉnlock: Ok, so the "best" doc for you is this one: https://docs.unlock-protocol.com/tutorials/locking-media-content
Locking media content | Unlock Protocol
In this tutorial, we will see how to create a simple HTML and JavaScript page to lock media content (audio or video) so that only the creators' members can play it.
[1:24 AM] Julien | Ʉnlock: I am happy to help if I can: just post links here
[2:40 AM] MercX: dope! I want to try and do it first if thats ok with you, best way for me to learn and makes it easier when I try to ask you for help LOL

1
[2:40 AM] MercX: Also, what if the content isnt so "simple"
[2:41 AM] MercX: ehhh you know what, I will try this doc out first thing in the morning
[2:41 AM] MercX: lol, ty for the help!

Currently, we only mention Guild when we talk about token Token-gating a Discord, which we had a blog post about. However, Guild.xyz can be used for many more things and we should be specific about how useful that is considering how many integrations they now have;

Discord: verification, role management and gating for channels and servers
Telegram: gated chats and voting
GitHub: access to private repositories
Google: gating Drive folders or native files such as Docs, Sheets, or Slides. Different roles can have different levels of permission to the same folder or file (view only / comment / edit).
POAP: setup within Guild and distribution via the Guild Discord bot with optional voice chat participation requirement and monetization
Anywhere with [the Guild SDK](https://we/ just came out with a major update, adding google, github and twitter integrations to guild https://twitter.com/guildxyz/status/1557403374416531466?s=20&t=8fXfDhRcyq24SSqGJ3oXwg): either to token gate parts of a website or application, or to mirror existing membership structures and bridge them to other platforms in the Guild ecosystem

https://docusaurus.io/docs/search
https://docsearch.algolia.com/apply/

We might want to update support for web3 browsers since we're a web3 company and native developers might be using heavily. Here is the best list I could come up with but of course some are so new we may want to wait on some below are my suggestions but feedback is appreciated. Please note we currently are using the default settings in docusaurus for browser support which are:

• chrome latest
• firefox latest
• safari latest

Suggest we add support now

• Brave / Marketshare - couldn't get a stat on this as % of overall marketshare but as the oldest web3 native browser that I'm aware of they've likely got quite a bit from our target audience. Some stats of note for consideration include 50.2M monthly active users and 15.5M daily active users as of Jan 2022 and they've essentially doubled user growth every year for the last 5yrs.
• Opera / Marketshare 2.14% - has made a big push and now supports a bunch web3 features like VPN, multi-network crypto wallet, and dApp support

Ones to watch

• Puma - only because alot of devs in the space are privacy conscious and use this as their mobile browser
• Opera Crypto - dedicated web3 centric browser launched back in January 2022. While this one is pioneered by Opera who already has a foothold on browser tech, it's still very new and I suggest we wait until it's more mature.
• Beaker
• Osiris

The locksmith OpenAPI manifest file misses lots of endpoints. We need to update it to include these endpoints.
However, before we do that we need to make sure it is used to generate docs.

Assigning to @searchableguy for the doc generation part and to @wonderwomancode for the completion part!

So we don't have to manually maintain this page.

https://docs.unlock-protocol.com/tools/subgraph

The following feedback was posted in the Discord server

[12:34 AM] LeonidasCrypto: @julien | Ʉnlock about Solarfist. Using unlock was very easy because I generated the link in the dashboard of Unlock for each NFT after the nft is purchased unlock will redirect the user to my app. Issues: there is no implementation or example how to call unlock for more complex scenarios with .NET. the documentation is great but I could not find examples how to use other cryptocurrency or token as payment: example I want to use a stable coin like USDT

• Code box style - the text are not readable, need to fix

We currently only touch on this briefly to let people know it's possible. I think we should give some step-by-step implementation examples.

• Checking data from an ERC-1155
• Using them with 3rd party API

Plugins and Integrations Doc

These apps have confirmed they can token-gate ERC-721s & have granted Unlock permission to be added our Plugins and Integrations docs.

Discord

• Guild: Manage roles & guard server
• Collab.land

Wordpress

• Unlock: Unlock Protocol
• Lit Protocol: Token / NFT / Blockchain Page Gating

Shopify

• Taco: NFT Loyalty Automation
• Manifold: Merch Bridge
• PERCS: NFT Gating
• AlphaSprouts: NFT Power-Ups
• Shopthru
• Lit Protocol: Token Access

Telegram

• Guild: Token gate your group
• Collab.land

Google Docs

• Guild: Token gate documents

Notion

• Monetized

Webflow

• Unlock Your Membership

Discourse

• Unlock Discourse plugin

Cloudflare

• Unlock
• Lit Protocol

Drupal

• Unlock Protoco

One time global

• Review global metadata
• Add robots file
• Wire up Google Search Console
• Optimize for Google Rich Results see https://search.google.com/test/rich-results

For every page

• Review single page metadata https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs
• Review for image metadata
• Review pages for structured content inside each main page, note docusaurus already renders pages w/ semantic markup for sidebar , navbar , main page
• Review pages for human readable links see https://docusaurus.io/docs/next/docs-introduction#document-id
• Upon publication to final URL, run page through Twitter Card Validator and immediately update if share image or snippet is incorrect on desktop or mobile https://cards-dev.twitter.com/validator

https://docs.unlock-protocol.com/governance/frequently-asked-questions#who-is-on-the-unlock-inc-team

We should probably put a team section on the main website that we just link to?

After a split between the founders MintGate is no longer using Unlock.

We don't make it clear there are two different flows developers can integrate into their applications.

We should make it clear when they would use checkout or sign in with ethereum and for what reasons. We should also list benefits over alternative or rolling out their own.

• enable the search feature for reader
• #38

Nice to have

• adding "is this useful" at bottom of the article
• change the dark/light mode to single toggle