From 74b489880469e8c70d458c83ae5252fa167489ad Mon Sep 17 00:00:00 2001 From: tamas6 <81620050+tamas6@users.noreply.github.com> Date: Mon, 4 Dec 2023 18:06:01 +0100 Subject: [PATCH 1/3] feat: docs update --- docs/CONTACT.md | 10 +++------- docs/GETTING-STARTED.md | 18 +++++++++++++++--- docs/USER-GUIDE.md | 24 +++++++++++++++--------- 3 files changed, 33 insertions(+), 19 deletions(-) diff --git a/docs/CONTACT.md b/docs/CONTACT.md index f33c498e..cd74bcc9 100644 --- a/docs/CONTACT.md +++ b/docs/CONTACT.md @@ -1,11 +1,10 @@ - # Contact Us If you have any questions, concerns, or feedback about Fairdrive, we'd love to hear from you! Here's how you can reach us: ## Discussions -You can join discussions on [GitHub](https://github.com/orgs/fairDataSociety/discussions) +You can join discussions on [GitHub](https://github.com/orgs/fairDataSociety/discussions) ## Social Media @@ -15,11 +14,8 @@ You can also reach out to us on social media: - [GitHub](https://github.com/fairDataSociety) - [Discord](https://discord.com/invite/vw3PmWf2rE) - ## Getting Help -If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). -Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). +If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). +Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). Developers can check [Development Instructions](DEVELOPMENT.md). - -If you can't find the answer to your question, feel free to [contact us](CONTACT.md). \ No newline at end of file diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md index 24b15af5..33224430 100644 --- a/docs/GETTING-STARTED.md +++ b/docs/GETTING-STARTED.md @@ -15,13 +15,25 @@ Fairdrive is a web application, so there's no need to install anything on your c ## Creating an Account -To use Fairdrive, you'll need to create an account. Here's how: +To use Fairdrive, you'll need to create an account, or migrate through Metamask. + +Follow these steps to create an account: 1. Go to the Fairdrive website. 2. Click on the "Sign Up" button. 3. Fill out the registration form with your details. 4. Click "Submit" to create your account. +Follow these steps to login with Metamask + +1. Install Metamask extension to Chrome. +2. Go to the Fairdrive website. +3. Click on the connect button in the right header corner. +4. Select Metamask, if you are not logged in currently, please login. +5. Provide a one-time-only password for athentication. +6. Send the neccessary gas fee. +7. When the funding is done, you are able to see the Fairdrive overview section. In this page you will see the migrate button above, to proceed with user credentials for interoperability. + ## Logging In Once you've created your account, you can log in to Fairdrive: @@ -41,8 +53,8 @@ Once you're logged in, you can start using Fairdrive to manage your pods, files, ## Getting Help -If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). -Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). +If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). +Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). Developers can check [Development Instructions](DEVELOPMENT.md). If you can't find the answer to your question, feel free to [contact us](CONTACT.md). diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index b75c14ed..de8515be 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -19,38 +19,45 @@ Welcome to the Fairdrive User Guide! This guide will walk you through all the fe To use Fairdrive, you'll need to create an account using any of below options. Here's how: #### 1. Using Metamask + 1. Click Connect -2. Select Metamask -3. Type passphrase +2. Select Metamask +3. Type passphrase 4. Connect Metamask to site with your preffered account 5. Sign Message #### 2. Using FDP Portable account + 1. Go to the Fairdrive website. 2. Click on the "Register New Account" button. 3. Fill out the registration form with your details. 4. When you finish procedure your FDP account will be ready -4. Login into Fairdrive using your username/password +5. Login into Fairdrive using your username/password #### 3. Using Bloosom extension + 1. Make sure you are logged in inside Blossom extension 2. Click Connect 3. Select Blossom 4. Allow Fairdrive full access of your personal storage ## Logging In + **Metamask** account: + 1. Click Connect 2. Enter passphrase -3. Sign message +3. Sign message **FDP Portable account** to log in to Fairdrive: + 1. Go to the Fairdrive website. 2. Click on the "Log In" button. 3. Enter your username and password. 4. Click "Submit" to log in. ## Account Migration + You have the option to transition your Metamask-created Lite account to an FDP Portable account. This transition enables you to utilize a username/password combination to access your data from mobile devices or other devices where Metamask isn't installed. Your Lite account will be connected with your new Portable account. During this transition process, you'll be given a new mnemonic. It's crucial to note this down and keep it in a secure location, as it will serve as your mnemonic for your Portable account recovery. @@ -59,6 +66,7 @@ During this transition process, you'll be given a new mnemonic. It's crucial to ## Manage Your Profile You can view your profile information at any time: + 1. Click on Blockie in the top right corner of the screen. 2. Dropdown menu will display available options. @@ -99,15 +107,13 @@ To search your pods, files, and directories: To change the theme of Fairdrive: -1. Click on Blockie in the top right corner of the screen. +1. Click on Blockie in the top right corner of the screen. 2. Click Theme Toggle. ## Getting Help -## Getting Help - -If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). -Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). +If you need help using Fairdrive, check out our [User Guide](USER-GUIDE.md) and [FAQ](FAQ.md). +Start [here](GETTING-STARTED.md) or see [Design](DESIGN.md), [Functionality](FUNCTIONALITY.md) or [Architecture](ARCHITECTURE.md). Developers can check [Development Instructions](DEVELOPMENT.md). If you can't find the answer to your question, feel free to [contact us](CONTACT.md). From 4fb115d8015122169cbd2137269e2e1095a72bbf Mon Sep 17 00:00:00 2001 From: tamas6 <81620050+tamas6@users.noreply.github.com> Date: Mon, 4 Dec 2023 18:12:19 +0100 Subject: [PATCH 2/3] typo fixx --- docs/USER-GUIDE.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index c51d5878..0a3163fa 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -23,11 +23,7 @@ To use Fairdrive, you'll need to create an account using any of below options. H 1. Click Connect 2. Select Metamask 3. Type passphrase -<<<<<<< HEAD -4. Connect Metamask to site with your preffered account -======= 4. Connect Metamask to site with your preferred account ->>>>>>> b33ba95f0aa99f54d47b2903d511fd45e954b0e0 5. Sign Message #### 2. Using FDP Portable account From b46c727b5fb405f9223e166cbee9534cee0fe807 Mon Sep 17 00:00:00 2001 From: tamas6 <81620050+tamas6@users.noreply.github.com> Date: Mon, 5 Feb 2024 17:16:33 +0100 Subject: [PATCH 3/3] docs: user guide updat --- docs/USER-GUIDE.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index 0a3163fa..917e1c4f 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -34,13 +34,6 @@ To use Fairdrive, you'll need to create an account using any of below options. H 4. When you finish procedure your FDP account will be ready 5. Login into Fairdrive using your username/password -#### 3. Using Bloosom extension - -1. Make sure you are logged in inside Blossom extension -2. Click Connect -3. Select Blossom -4. Allow Fairdrive full access of your personal storage - ## Logging In **Metamask** account: @@ -49,7 +42,7 @@ To use Fairdrive, you'll need to create an account using any of below options. H 2. Enter passphrase 3. Sign message -**FDP Portable account** to log in to Fairdrive: +**FDP Portable account** (development only) to log in to Fairdrive: 1. Go to the Fairdrive website. 2. Click on the "Log In" button.