Skip to content

Commit

Permalink
Write docs on AuthSigs, SessionSigs, PKPs (#66)
Browse files Browse the repository at this point in the history
* Write docs on AuthSigs, SessionSigs, PKPs

* feat: JsonAuthSig is now AuthSig, update links

* wip: comment out methods for now

* fix: link styling

* feat: update toml, readme

* feat: link to eip

* [Refactor] Authentication section under SDK (#75)

* empty commit

* update SDK to get latest chains

* feat: update faq

* chore: main

* AuthSig link fixes

* fix: feedback

* Update links to reference faucet (#73)

* Update links to reference faucet w/ Chronicle update

* fix: grammar

Co-authored-by: debie <[email protected]>

* fix: remove stale q

* update contract addresses (#74)

* wip: auth section

* feat: flesh out auth section

* Add some docs on PKP Permissions Auth methods.  Add a note about Chronicle and signing stuff on other chains. (#76)

* add note about chronicle signing

* add a table of auth methods

* Update docs/intro/rollup.mdx

Co-authored-by: sarah z <[email protected]>

---------

Co-authored-by: sarah z <[email protected]>

* add lit test token note for pkp minting

* refactor: reorg auth methods

* fix: styling

* add note to FAQ

* review comment

* Add an issue template

* fix: feedback

Co-authored-by: Howard <[email protected]>

* fix: spelling

Co-authored-by: Howard <[email protected]>

* fix: feedback

Co-authored-by: Howard <[email protected]>

* fix: feedback

Co-authored-by: Howard <[email protected]>

* fix: feedback

---------

Co-authored-by: Chris Cassano <[email protected]>
Co-authored-by: debie <[email protected]>
Co-authored-by: Josh Long <[email protected]>
Co-authored-by: Howard <[email protected]>

* Update docs on session sigs, lit resources, abilities + address PR feedback

* Remove comment

* Address PR feedback

* Update js-sdk version

* Fix rebase

---------

Co-authored-by: sarahzdev <[email protected]>
Co-authored-by: sarah z <[email protected]>
Co-authored-by: Chris Cassano <[email protected]>
Co-authored-by: debie <[email protected]>
Co-authored-by: Josh Long <[email protected]>
  • Loading branch information
6 people authored May 18, 2023
1 parent 881bdfa commit c46ace5
Show file tree
Hide file tree
Showing 26 changed files with 904 additions and 340 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ If you are using GitHub pages for hosting, this command is a convenient way to b

## ✨ Workflow

When adding new content or re-organizing existing content, please be sure to update the sidebar file `sidebars.js`.
When adding new content or re-organizing existing content, please be sure to update the following:

1. Sidebar file - `sidebars.js`
2. Redirects file - `netlify.toml`

### Updating the sidebar

To create a top-level, **noncollapsible** category like `Getting Started`, add the following to the `docs` array:

Expand Down Expand Up @@ -100,4 +105,16 @@ docs: [
],
}
]
```

### Setting redirects

If you are changing the path of a page, you will need to add a redirect to the `netlify.toml` file. For example, if you are changing the path of `docs/tea-drinks/intro.md` to `docs/tea-drinks/tea-drinks-intro.md`, you will need to add the following to the `netlify.toml` file:

```toml
[[redirects]]
from = "/docs/tea-drinks/intro"
to = "/docs/tea-drinks/tea-drinks-intro"
status = 301
force = false
```
2 changes: 1 addition & 1 deletion docs/LitActions/additionalExamples/generatingSessionKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Generating a Session Key

This [example](https://github.com/LIT-Protocol/js-serverless-function-test/blob/main/js-sdkTests/sessionKeys.js) demonstrates how to generate a signed [session key](/SDK/Explanation/WalletSigs/sessionSigs) using Lit Actions.
This [example](https://github.com/LIT-Protocol/js-serverless-function-test/blob/main/js-sdkTests/sessionKeys.js) demonstrates how to generate a signed [session key](/SDK/Explanation/authentication/sessionSigs) using Lit Actions.

``` js
// this example will generate and sign a session key and use it for a request
Expand Down
4 changes: 0 additions & 4 deletions docs/SDK/Explanation/WalletSigs/_category_.json

This file was deleted.

99 changes: 0 additions & 99 deletions docs/SDK/Explanation/WalletSigs/authSig.md

This file was deleted.

Loading

0 comments on commit c46ace5

Please sign in to comment.