Skip to content
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

Reorganising file structure to be easier to navigate sidebar #78

Merged
merged 18 commits into from
May 13, 2024
Merged
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
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cSpell.words": ["lukso"]
}
16 changes: 13 additions & 3 deletions docs/contact-us/contact-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,17 @@ description: General Support Page for LUKSO

## How can I contact LUKSO support?

Our two channels for support are:
### Discord

- [Discord](https://discord.com/channels/359064931246538762/1227624285259038731)
- [email](mailto:[email protected])
Come and join our [Discord server](https://discord.com/channels/359064931246538762/1227624285259038731)!
Here we have various channels to help you, such as the ones below:

- `validators`: Node and Network related questions
- `dev-chat`: Questions about tools, backend, and dApps
- `standards`: Questions about LSPs and their integration
- `documentation`: Improvement proposals for our technical guides
- `support`: Raise a support ticket for us and other community members to respond to

### Email

Alternatively, Email us @ [[email protected]](mailto:[email protected])
24 changes: 24 additions & 0 deletions docs/general/community/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_label: '👯‍♂️ Community'
sidebar_position: 7
description: Links on where to stay up to date with LUKSO
---

# Follow Us

If you'd like to stay up to date with all of the latest LUKSO news, then we recommend the following us in the places listed below.

## Twitter

We have two main accounts:

1. [LUKSO](https://twitter.com/lukso_io) - where we tweet about all things happening in LUKSO
2. [ERC725](https://twitter.com/ERC725Account) - where we tweet about mainly developer oriented topics

## Discord

You can also contact us on [Discord](https://discord.com/invite/lukso).

We're very active so you can speak to our support teams, devs, designers....pretty much anyone.

Most importantly, you'll find the community here. People building dapps on LUKSO, or LUKSO dApps users.
33 changes: 33 additions & 0 deletions docs/general/faq/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_label: '❓ FAQ'
sidebar_position: 6
description: 'Frequently asked questions'
---

# FAQ

## Does LUKSO have a grants program?

Yes, absolutely! Please go to our main [grants program page](https://lukso.network/grants) for more information and to apply!

## Why can't I delete my old private keys?

At the moment, the Universal Profile Browser Extension only allows to disable permissions of old controller keys. If you want to improve security, please disable all permissions of an old controller. You can learn more within the [Controllers](/docs/general/getting-started/Extension/controllers.md) page. Soon, there will be a feature to manually remove controllers completely.

## Why I can't I see all my controllers?

If you remove all permissions of a controller, it will be automatically hidden within the extension. If you want to temporarily disable some permissions of a controller, please leave one minor permission set for now. This behavior will be changed within the future.

## Why can't I delete profiles from the extension?

Right now, you can not remove profiles from the dashboard on [my.universalprofile.cloud](https://my.universalprofile.cloud/) or the Universal Profile Extension. Soon, there will be a feature to clean old profiles.

## Why does my NFT not show up on UniversalProfile.cloud?

If your deployed assets do not appear on your profile on [universalprofile.cloud](https://universalprofile.cloud/), they may be using outdated InterfaceIDs from deprecated LSP versions. Ensure you are using up-to-date [LSP Interface IDs](https://docs.lukso.tech/contracts/interface-ids) as defined in the [lsp-smart-contracts](https://www.npmjs.com/package/@lukso/lsp-smart-contracts) library.

## Why does my profile show as anonymous?

Due to some changes in how data is added to the Universal Profile in the early days, it might happen that your profile does not have a name to it or shows completely anonymous on [universalprofile.cloud](https://universalprofile.cloud/) without any pictures. If you experience such an issue, please **edit and deploy your profile metadata** again within the Universal Profile Browser Extension as shown in the following picture:

![Edit Universal Profile](../../../static/img/general/edit-profile.png)
23 changes: 0 additions & 23 deletions docs/general/feature-requests.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/general/getting-started/Extension/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
label: '📔 Extension'
collapsed: true
position: 3
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ This error occurs if a user deployed his Universal Profile through a 3rd party p
<div style={{textAlign: 'center'}}>

<img
src="/img/general/relay-service-tx-error.png"
src="/../../img/general/relay-service-tx-error.png"
alt="Relay Service Transaction Error"
width="400"
/>

</div>

To **solve this issue**, users have to [**fund the extension's controller**](../extension/guides/fund-controller.md) with LYX to execute transactions without any Transaction Relay Service. Within the transaction screen, users can then select to use their own controller's funds.
To **solve this issue**, users have to [**fund the extension's controller**](/general/getting-started/Extension/guides/fund-controller.md) with LYX to execute transactions without any Transaction Relay Service. Within the transaction screen, users can then select to use their own controller's funds.

:::caution

If you face this error in combination with **no sign permissions** after recovering your profile, the issue is likely related to [our recent controller incident](./incidents/controller-recovery.md). Therefore, please make sure that you either have [2FA recovery set up correctly](./guides/check-2fa-recovery.md) or revealed the private key of the [extension's controller](controllers.md) within the Settings screen. Both methods will ensure you will be able to regain access to your Universal Profile. More information can be found in the [Backup](./guides/create-backup.md) section.
If you face this error in combination with **no sign permissions** after recovering your profile, the issue is likely related to [our recent controller incident](/general/getting-started/Extension/incidents/controller-recovery.md). Therefore, please make sure that you either have [2FA recovery set up correctly](/general/getting-started/Extension/guides/check-2fa-recovery.md) or revealed the private key of the [extension's controller](controllers.md) within the Settings screen. Both methods will ensure you will be able to regain access to your Universal Profile. More information can be found in the [Backup](/general/getting-started/Extension/guides/create-backup.md) section.

:::

Expand All @@ -45,7 +45,7 @@ When you want to recover a profile using 2FA on the [my.universalprofile.cloud](
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/recovery-failed.png"
src="/../img/extension/recovery-failed.png"
alt="Recovery Error Message"
width="600"
/>
Expand All @@ -54,7 +54,7 @@ When you want to recover a profile using 2FA on the [my.universalprofile.cloud](

To **solve this issue**, please

- [**verify that 2FA is set up on a specific profile**](../extension/guides/check-2fa-recovery.md): If 2FA was not set up, you can not recover your profile from the dashboard. Please look into the optional [Backup](./guides/create-backup.md) solutions.
- [**verify that 2FA is set up on a specific profile**](general/getting-started/Extension/guides/check-2fa-recovery.md): If 2FA was not set up, you can not recover your profile from the dashboard. Please look into the optional [Backup](general/getting-started/Extension/guides/create-backup.md) solutions.
- **verify that you logged in with the correct email account**: The email or Google Account you've used might differ from the one that you previously set for authentication. Chrome may automatically connect with the Google account of your browser profile instead of asking for another login. If the accounts do not match, the Transaction Relay Service won't recognize the account, indicating that no recovery was set up.

:::danger
Expand All @@ -68,7 +68,7 @@ If you neither have 2FA, access to the profile within the extension, or the back
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/add-up-stall.png"
src="/../img/extension/add-up-stall.png"
alt="Add Profile to Extension Error"
width="600"
/>
Expand Down Expand Up @@ -100,7 +100,7 @@ It might happen that your profile data, like pictures and name, can not be fetch
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/error-fetch-data.png"
src="/../img/extension/error-fetch-data.png"
alt="Error fetching profile data"
width="300"
/>
Expand All @@ -109,7 +109,7 @@ It might happen that your profile data, like pictures and name, can not be fetch

To **solve this issue**, please **edit and re-deploy** your profile metadata **within the Universal Profile Browser Extension**. This will update the metadata file using the correct and up-to-date schema, so apps are able to fetch it again:

![Edit Universal Profile](../../static/img/general/edit-profile.png)
![Edit Universal Profile](../../../../static/img/general/edit-profile.png)

## Incorrect 2FA Code

Expand All @@ -118,7 +118,7 @@ This error might occur when you want to recover your Universal Profile using the
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/2fa-auth-fail.png"
src="/../img/extension/2fa-auth-fail.png"
alt="Incorrect 2FA Code"
width="300"
/>
Expand All @@ -134,7 +134,7 @@ This error might occur when you are trying to recover your profile from 2FA and
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/re-authenticate.png"
src="/../img/extension/re-authenticate.png"
alt="Authentication Expired"
width="300"
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Each Universal Profile within an extension holds a separate private key to send
<div style={{textAlign: 'center'}}>

<img
src="/img/extension/controller-window.png"
src="../../../../static/img/extension/controller-window.png"
alt="Controller Window"
width="400"
/>
Expand All @@ -31,7 +31,7 @@ After the initial creation, there can be up to 3 controllers:
The names of the controllers can vary, depending on the time of your Universal Profile setup. The controller of the extension will either be named **UP Extension** or have the **name of it's blockchain address**. The recovery controller can either be named **UP Recovery**, **Create and manage your UP**, or **recovery-up\<number\>**. Every controller can be _renamed locally_ in your extension at any time.

<img
src="/img/extension/controller-name.png"
src="../../../../static/img/extension/controller-name.png"
alt="Controller Name Change"
width="600"
/>
Expand All @@ -46,9 +46,9 @@ If you **import or recover** your Universal Profile, it will result in the addit

Please do not **reinstall or reset** your extension if you do not have either of the following safeguards:

- [2FA Recovery set up correctly](./guides/check-2fa-recovery.md)
- [Wallet Recovery](./guides/set-wallet-recovery.md)
- [Revealed the private key using File Export](./guides/create-backup.md)
- [2FA Recovery set up correctly](docs/general/getting-started/Extension/guides/check-2fa-recovery.md)
- [Wallet Recovery](docs/general/getting-started/Extension/guides/set-wallet-recovery.md)
- [Revealed the private key using File Export](docs/general/getting-started/Extension/guides/create-backup.md)
- Access to the profile within another extension

Otherwise, **you will not be able to access your profile, including LYX and assets**, as no new controller can be added without a transaction from one of the existing ones. Not having access to a working controller will cause endless import screens, waiting for a recovery transaction that can never be signed.
Expand All @@ -59,7 +59,7 @@ Otherwise, **you will not be able to access your profile, including LYX and asse

To check the 2FA recovery status and add 2FA, please visit the dashboard on [my.universalprofile.cloud](https://my.universalprofile.cloud/). The Universal Profile card will show the current **2FA recovery status** at the top right corner. If 2FA has not been added yet, continue by clicking the **Add Recovery** button.

![2FA Recovery Dashboard](/img/general/recovery-dashboard.png)
![2FA Recovery Dashboard](../../../../static/img/general/recovery-dashboard.png)

:::warning

Expand Down Expand Up @@ -96,35 +96,35 @@ If you want to reset the controller permissions to their initial state, you can
<details>
<summary>Show default permissions of the Universal Profile Extension</summary>

![Default Permissions of the Universal Profile Extension](../../static/img/extension/default-permission-up-extension.png)
![Default Permissions of the Universal Profile Extension](../../../../static/img/extension/default-permission-up-extension.png)

</details>

<details>
<summary>Show default permissions of the Universal Receiver</summary>

![Default Permissions of the Universal Receiver](../../static/img/extension/default-permission-universal-receiver.png)
![Default Permissions of the Universal Receiver](../../../../static/img/extension/default-permission-universal-receiver.png)

</details>

<details>
<summary>Show default permissions of the Universal Profile Recovery</summary>

![Default Permissions of the Universal Profile Recovery](../../static/img/extension/default-permission-up-recovery.png)
![Default Permissions of the Universal Profile Recovery](../../../../static/img/extension/default-permission-up-recovery.png)

</details>

## Can I add a Ledger account as a controller of my profile?

Yes, you can add blockchain accounts or hardware wallets (like Ledger or Trezor) for recovery using the [Wallet Recovery Setup](../extension/guides/set-wallet-recovery.md).
Yes, you can add blockchain accounts or hardware wallets (like Ledger or Trezor) for recovery using the [Wallet Recovery Setup](docs/general/getting-started/Extension/guides/set-wallet-recovery.md).

## How can I remove controllers and permissions?

To remove permissions, use the extension to view all controllers with permissions on the profile. You can toggle off permissions individually. Controllers can not be removed completely via the extension. Controllers without permissions will continue to show but with a `No control` label.

:::success Upcoming Feature

The team is currently working on a [feature request](../general/feature-requests.md) to _completely remove old controllers_, not only their individual permissions.
The team is currently working on a feature request to _completely remove old controllers_, not only their individual permissions.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you want a personal backup solution for your Universal Profile, you can add a

## Preparation

To add a new controller account to your Universal Profile, you will need the [Universal Profile Browser Extension](https://chromewebstore.google.com/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn) as well as an [Ethereum wallet with custom network support](../../general/wallet-support.md) installed **in the same [supported browser](../introduction.md#which-browsers-does-the-extension-support)**.
To add a new controller account to your Universal Profile, you will need the [Universal Profile Browser Extension](https://chromewebstore.google.com/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn) as well as an [Ethereum wallet with custom network support](/general/supported-wallets/wallet-support.md) installed **in the same [supported browser](../introduction.md#which-browsers-does-the-extension-support)**.

:::tip Wallet Support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you've set a **recovery controller** using the [Wallet Recovery Setup](./set-

## Preparation

In order to recover your Universal Profile, you will need the [Universal Profile Browser Extension](https://chromewebstore.google.com/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn) and an [Ethereum wallet with custom network support](../../general/wallet-support.md) installed **in the same [supported browser](../introduction.md#which-browsers-does-the-extension-support)**.
In order to recover your Universal Profile, you will need the [Universal Profile Browser Extension](https://chromewebstore.google.com/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn) and an [Ethereum wallet with custom network support](docs/general/supported-wallets/wallet-support.md) installed **in the same [supported browser](../introduction.md#which-browsers-does-the-extension-support)**.

:::tip Wallet Support

Expand All @@ -27,7 +27,7 @@ Before you can recover your Universal Profile, ensure that:

:::info Using Hardware Wallets

If you are using a hardware wallet to recover your Universal Profile, please ensure that the correct security settings are enabled. For Ledger, you must allow **blind signing** within the Ethereum app on the device to execute smart contract transactions like the recovery. If you are using Trezor, you will have to adjust the [strict security rules](../../general/hardware-wallets.md#how-to-send-transactions-using-trezor-wallet) due to the network ID.
If you are using a hardware wallet to recover your Universal Profile, please ensure that the correct security settings are enabled. For Ledger, you must allow **blind signing** within the Ethereum app on the device to execute smart contract transactions like the recovery. If you are using Trezor, you will have to adjust the [strict security rules](docs/general/supported-wallets/hardware-wallets.md#how-to-send-transactions-using-trezor-wallet) due to the network ID.

:::

Expand Down
3 changes: 3 additions & 0 deletions docs/general/getting-started/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
label: ' 👨‍🚀 Getting Started'
collapsed: true
position: 2
16 changes: 16 additions & 0 deletions docs/general/getting-started/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_label: '🚀 Getting Started'
sidebar_position: 1
description: 'LUKSO Support: Universal Profile Controllers'
---

# Getting Started

This section is aimed at getting your from zero knowledge --> interacting with dapps on the LUKSO blockchain.

**The guide is broken down into 4 sections**:

1. Creating your Universal Profile
2. Downloading our 🆙 browser extension
3. Buying some LYX
4. Sign posting you to some popular dapps on LUKSO
11 changes: 11 additions & 0 deletions docs/general/getting-started/popular-dapps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_label: '🤖 Popular Dapps'
sidebar_position: 4
description: Some interesting dapps built on LUKSO
---

# Popular Dapps and Projects

:::info
This page is under construction
:::
Loading
Loading