Skip to content

Commit

Permalink
Fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
r-n-o committed Nov 7, 2023
1 parent 82e1e71 commit 845ff8c
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Think about Turnkey API keys as an access-gating mechanism to Turnkey functional

### Are there limits on how many resources I can create, or activities I can execute?

We have limits on the number of resources within a single organization to avoid performance slowdowns. You can scale your organizational resources beyond these limits via [sub-organizations](./getting-started/sub-organizations.md). You can create an unlimited number of sub-organizations within a single organization.
We have limits on the number of resources within a single organization to avoid performance slowdowns. You can scale your organizational resources beyond these limits via [sub-organizations](./getting-started/Sub-Organizations.md). You can create an unlimited number of sub-organizations within a single organization.

Currently, the resource limits within a single organization are as follows:

Expand Down
6 changes: 3 additions & 3 deletions docs/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /



Read here for a quick primer on our high-level product structure to orient you to the rest of the documentation. If you’d rather jump straight into the quickstart, head [here](./getting-started/quickstart.md).
Read here for a quick primer on our high-level product structure to orient you to the rest of the documentation. If you’d rather jump straight into the quickstart, head [here](./getting-started/Quickstart.md).

### About Turnkey

Expand Down Expand Up @@ -41,8 +41,8 @@ All secure workloads, including key management and transaction signing, are mana

### Where to head next

[Quickstart guide](./getting-started/quickstart.md): Walk through setup of the Turnkey API and Platform, create a crypto Private Key, and sign your first transaction via command line.
[Quickstart guide](./getting-started/Quickstart.md): Walk through setup of the Turnkey API and Platform, create a crypto Private Key, and sign your first transaction via command line.

[Examples](./getting-started/examples.md): Turnkey’s flexible infrastructure means there’s a lot you can build. Check out a few of our own examples to get a picture of what’s possible.
[Examples](./getting-started/Examples.md): Turnkey’s flexible infrastructure means there’s a lot you can build. Check out a few of our own examples to get a picture of what’s possible.

[Security architecture](./security/our-approach.md): Turnkey’s unique security architecture is the foundation of our product. Dive in to understand how we secure your keys.
2 changes: 1 addition & 1 deletion docs/getting-started/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ See https://github.com/tkhq/demo-consumer-wallet for the code.
### Demo Passkey Wallet ([code](https://github.com/tkhq/demo-passkey-wallet), [live link](https://wallet.tx.xyz))

A wallet application showing how users can register and authenticate using passkeys.
This demo uses the Turnkey API to create a new [Turnkey Sub-Organization](./sub-organizations.md) for each user, create a testnet Ethereum address and send a transaction on Sepolia (ETH testnet).
This demo uses the Turnkey API to create a new [Turnkey Sub-Organization](./Sub-Organizations.md) for each user, create a testnet Ethereum address and send a transaction on Sepolia (ETH testnet).

<img src="/demo-passkey-wallet.png" alt="homepage screenshot" width="800px"/>

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/email-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Important note: recovery credentials automatically expire after **30 minutes** a

## Email recovery in your sub-organizations

Email recovery works well with [sub-organization](./sub-organizations.md). Our Demo Passkey Wallet application (https://wallet.tx.xyz) has recovery functionality integrated. We encourage you to try it (and look at [the code](https://github.com/tkhq/demo-passkey-wallet) if you're curious!).
Email recovery works well with [sub-organization](./Sub-Organizations.md). Our Demo Passkey Wallet application (https://wallet.tx.xyz) has recovery functionality integrated. We encourage you to try it (and look at [the code](https://github.com/tkhq/demo-passkey-wallet) if you're curious!).

If you're looking for a more concrete implementation guide, head to [Sub-Organization Recovery](../integration-guides/email-recovery-in-sub-organizations.md) for more details.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ slug: /integration-guides/sub-organization-recovery
---
# Sub-Organization Recovery

Email recovery shines if you are leveraging [sub-organizations](../getting-started/sub-organizations.md) for each of your users. This allows your users to recover their Turnkey account if something goes wrong with their passkeys, and keeps you out of the loop: we engineered this feature to ensure your organization is unable to take over sub-organizations even if it wanted to.
Email recovery shines if you are leveraging [sub-organizations](../getting-started/Sub-Organizations.md) for each of your users. This allows your users to recover their Turnkey account if something goes wrong with their passkeys, and keeps you out of the loop: we engineered this feature to ensure your organization is unable to take over sub-organizations even if it wanted to.

Our Demo Passkey Wallet application (https://wallet.tx.xyz) has recovery functionality integrated. We encourage you to try it (and look at [the code](https://github.com/tkhq/demo-passkey-wallet)) before diving into your own implementation.

## Pre-requisites

Make sure you have set up your primary Turnkey organization as well as one or more users with API access that will programmatically initiate email recovery. Check out our [Quickstart guide](../getting-started/quickstart.md) if you need help getting started. To allow an API user to initiate recovery, you'll need the following policy in your main organization:
Make sure you have set up your primary Turnkey organization as well as one or more users with API access that will programmatically initiate email recovery. Check out our [Quickstart guide](../getting-started/Quickstart.md) if you need help getting started. To allow an API user to initiate recovery, you'll need the following policy in your main organization:
```json JSON
{
"effect": "EFFECT_ALLOW",
Expand Down
4 changes: 2 additions & 2 deletions docs/integration-guides/sub-organizations-as-wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /integration-guides/sub-organizations-as-wallets

Turnkey has built a new model for private key management that utilizes secure enclaves. All transactions are signed within an enclave and private keys are never exposed to Turnkey, your software, or your team. Turnkey’s role is similar to that of a safety deposit box operator — Turnkey secures and provides access to the safety deposit boxes, but our system requires cryptographic proof of ownership to take any action with the keys held within.

We've seen in [Sub-Organizations](../getting-started/sub-organizations.md) that sub-organizations are independent from their parent. This guide walks through 3 ways to use sub-organizations as wallets for your users. We first show that it can be used to create non-custodial wallets, or end-user controlled wallets. Then we explain how you can create custodial wallets or shared custody wallets using the same primitive.
We've seen in [Sub-Organizations](../getting-started/Sub-Organizations.md) that sub-organizations are independent from their parent. This guide walks through 3 ways to use sub-organizations as wallets for your users. We first show that it can be used to create non-custodial wallets, or end-user controlled wallets. Then we explain how you can create custodial wallets or shared custody wallets using the same primitive.

## Sub-Organizations as end-user controlled wallets

Expand All @@ -19,7 +19,7 @@ If you'd like to see a live example, head over to our [✨Demo Passkey Wallet✨

### Before you start

Make sure you’ve set up your primary Turnkey organization as well as one or more users with API access that will programmatically manage user onboarding within your application. Check out our [Quickstart guide](../getting-started/quickstart.md) if you need help getting started.
Make sure you’ve set up your primary Turnkey organization as well as one or more users with API access that will programmatically manage user onboarding within your application. Check out our [Quickstart guide](../getting-started/Quickstart.md) if you need help getting started.

### Step 1: create a sub-organization

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const config = {
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

// Even if you don't use internalization, you can use this field to set useful
// Even if you don't use internationalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
Expand Down

0 comments on commit 845ff8c

Please sign in to comment.