From 50c2ce300f04bb7eee28f68bb99b010c75b5fb18 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Fri, 6 Oct 2023 12:23:24 +0000 Subject: [PATCH 1/3] add community shard docs --- docs/community-shard/chat.md | 54 ++++++++++++ .../community-portal-access.md | 88 +++++++++++++++++++ docs/community-shard/docs.md | 5 ++ docs/community-shard/shard-runners.md | 43 +++++++++ docs/community-shard/task.md | 5 ++ docs/intro.md | 15 +++- sidebars.js | 12 +++ 7 files changed, 218 insertions(+), 4 deletions(-) create mode 100644 docs/community-shard/chat.md create mode 100644 docs/community-shard/community-portal-access.md create mode 100644 docs/community-shard/docs.md create mode 100644 docs/community-shard/shard-runners.md create mode 100644 docs/community-shard/task.md diff --git a/docs/community-shard/chat.md b/docs/community-shard/chat.md new file mode 100644 index 00000000..19070596 --- /dev/null +++ b/docs/community-shard/chat.md @@ -0,0 +1,54 @@ +--- +title: Decentralized Chat +sidebar_label: Chat +sidebar_position: 3 +--- + +:::info +This is our beta release, and we are continuously adding new features to enhance your experience. +::: + + +Calimero Chat is a versatile chat platform designed to enhance your communication experience. It offers a mobile-friendly interface, channels for organized conversations, and features like image sharing, mentions, and profile customization to make your chats more engaging and efficient. + +Screenshot 2023-10-06 at 00 55 21 + +## Navigating the Interface + +Calimero Chat's interface is optimized for mobile devices, ensuring you can chat on the go with ease. + +### Sidebar and Channels +- Access the sidebar to manage channels and conversations. +- Create new channels to organize discussions around specific topics or teams. + +Screenshot 2023-10-06 at 01 12 14 + + +### Creating and Joining Channels +To create a new channel: + +- Click on the Channel header in your sidebar. +- Give your channel a name. +- Click **Create**. + +To join an existing channel, search for it in the sidebar and Join. + +### Sharing Images + +To share images in your chat: + +- Click on the icon next to the message field. +- Choose **Upload an Image**. +- Select the image files you want to share. +- Click the **Send icon** + +Screenshot 2023-10-06 at 01 05 04 + + +## Adding a Profile Picture + +Sync your profile picture from near.social: + +- Visit near.social to upload your desired profile picture. +- It will automatically sync and display here in Calimero Chat. + diff --git a/docs/community-shard/community-portal-access.md b/docs/community-shard/community-portal-access.md new file mode 100644 index 00000000..a23ca1bc --- /dev/null +++ b/docs/community-shard/community-portal-access.md @@ -0,0 +1,88 @@ +--- +title: Community Portal Access +sidebar_label: Community Portal Access +sidebar_position: 2 +--- + + +This guide will walk you through the process of setting up and connecting your account. + +calimero-community-portal + +## Access the Community Portal +- Open your browser and navigate to [Community Portal](https://portal.calimero.network). +- Click on the **Continue with Wallet** button. + +:::info +During our beta phase, the community portal is exclusively compatible with MyNearWallet. We're actively working alongside our partners to incorporate email sign-in capabilities. Updates will be provided as new integrations are rolled out. +::: + +## Wallet Selection +- Choose the **MyNearWallet** from the sidebar. + +calimero-community-portal + +## Import Your Existing Account + +:::info +If you already hold an active account in MyNearWallet, you can proceed to the next step. +::: + +- Select **Import Existing Account** + +calimero-community-portal + +- Create a new password + +calimero-community-portal + +- Select the account recovery method you've set up (options include _email, phone, paraphrase, ledger, or private key_) to import your account. + +calimero-community-portal + +## Disable Password protection +We've identified some issues related to password protection in MNW. We are actively working with the MNW team to resolve this swiftly. In the interim, we advise temporarily disabling it + +- Unlock your [MyNearwallet](https://app.mynearwallet.com/) with your password +- Click to the **Account** tab + +calimero-community-portal + +- On the right side, click on disable password protection + +calimero-community-portal + +## Near Social Login +- After successfully importing your account, Click **Next** to grant permission for the Calimero dapp to access your NEAR account. + +calimero-community-portal + +- Then click on **Connect** to sync your NEAR account to the Calimero dapp to enable it execute methods on the Calimero dapp on behalf of your NEAR account. + +calimero-community-portal + +## Application Selection +Once connected, select the specific application you wish to sign into. To access the Calimero Mero application, choose Chat from the dropdown menu and then click Join. + +Screenshot 2023-10-06 at 00 30 41 + +:::note +Each application requires separate sign-in access. Signing in to one application does not grant access to all applications. If you want to access the Boards you need to sign in to that and vice versa. +::: + +## Sync Your NEAR Account with the Calimero Private Shard + +For the application you want to sign into, click Next to sync your NEAR account with the Calimero private shard. This action grants permissions and add a limited access key. + +Screenshot 2023-10-06 at 00 30 41 + +:::note +Transactions on the private shard won't impact your NEAR balance or main account +::: + +## Connect your Application to your NEAR account +Click on **Connect** to enable the smart contract from the application you want to connect to call methods on behalf of your NEAR account. + +Screenshot 2023-10-06 at 00 30 41 + +That is it! You're now access the application you connected. \ No newline at end of file diff --git a/docs/community-shard/docs.md b/docs/community-shard/docs.md new file mode 100644 index 00000000..3945e899 --- /dev/null +++ b/docs/community-shard/docs.md @@ -0,0 +1,5 @@ +--- +title: Docs +sidebar_label: Document sharing +sidebar_position: 5 +--- \ No newline at end of file diff --git a/docs/community-shard/shard-runners.md b/docs/community-shard/shard-runners.md new file mode 100644 index 00000000..47a9d1b5 --- /dev/null +++ b/docs/community-shard/shard-runners.md @@ -0,0 +1,43 @@ +--- +title: Community Shard Runners +sidebar_label: Community Shard Runners +sidebar_position: 1 +slug: /community-shard +--- + + +The Community Shard is a unique and exclusive private shard powered by the latest nearcore version. It operates in close collaboration with key players from the NEAR ecosystem and is designed to support the use of BOS components while showcasing examples of Open Web applications. These applications can be utilized as-is or customized to meet the specific needs of individual companies within their private setups. + +## Our Vision + +Our primary goal in establishing the Community Shard is not to compete with the public BOS. Instead, it serves as an exclusive hub entirely dedicated to the development of Open Web applications. Certain applications, such as chats, project management tools, HR systems, forms, and docs, are better suited for operation within a private environment. Calimero provides this private environment to ensure their optimal functionality. + +## How the Community Shards Operate + +### Collective Ownership + +Community shards operate on a unique model of collective ownership. Multiple companies come together to co-own and jointly maintain these shards. + +### Inclusive Accessibility + +Community shards are intentionally designed to be fully accessible to the public. They are open to a wide array of users, including members of the Beta Tester group. This open-door policy fosters inclusivity and actively nurtures the development of public communities. Users are welcome to participate in public discussions, interact with one another, and conduct transactions without any financial barriers. + +### Decentralized Data Hosting + +Participating companies can host data required for their community shard applications. Each company's contribution to data hosting collectively support the shard's integrity and reliability. + +### Tailored Flexibility + +Calimero acknowledges that diverse communities possess unique needs and preferences. As a result, the system offers tailored flexibility for communities that aspire to have their dedicated community shards. This customization empowers communities to curate an environment that aligns precisely with their specific requirements. + +### Seamless Data Migration + +A standout advantage of community shards is the seamless data migration feature. As long as at least one entity within the shard operates with honesty and transparency, users can confidently migrate their data from old shards to new ones. This feature ensures data continuity and minimizes disruptions during transitions. + +## Participation Requirements + +To become part of the community shard ecosystem, companies are required to: + +- Believe in the idea of the Open Web and be open to experiments. +- Be an active company in the NEAR ecosystem. +- Create a Calimero account (takes about one minute to create). diff --git a/docs/community-shard/task.md b/docs/community-shard/task.md new file mode 100644 index 00000000..febe3af9 --- /dev/null +++ b/docs/community-shard/task.md @@ -0,0 +1,5 @@ +--- +title: Docs +sidebar_label: Task Manager +sidebar_position: 4 +--- \ No newline at end of file diff --git a/docs/intro.md b/docs/intro.md index 978f3fe8..771862d4 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -13,15 +13,22 @@ image: https://github.com/calimero-is-near/docs/assets/39309699/701bb5e3-fb3e-42 -Calimero is a customizable sidechain built on top of NEAR protocol. It can be viewed as a network of networks. A solution for businesses to access privacy features and enable scaling. Calimero provides you with an infrastructure which shares all the best benefits of NEAR while being enhanced with multiple new features with emphasis on privacy. +Calimero is a customizable sidechain built on top of NEAR protocol. It can be viewed as a network of networks. A solution for businesses to access privacy features and enable scaling. Calimero provides you with an infrastructure which shares all the best benefits of NEAR while being enhanced with multiple new features with emphasis on privacy. Calimero enables you to: - Spin off your own private shards (think of a shard as a small private blockchain network that you own) - - Communicate between your shards and other networks, or between multiple shards (even if the shards are owned by different companies) -## What is Calimero private shard? + +## Calimero Open Web + +Calimero is at the forefront of building a more user-centric web: the Open Web. Our goal? To give users, communities, and businesses the tools they need to truly own and control their data. Think of it as having the convenience of popular software services, but hosted by you, where your data stays yours. + +We've leveraged the power of the NEAR Protocol and the Blockchain Operating System (BOS) to create this platform. With Calimero, you get a private space online where you're in control. It comes equipped with a range of open-source apps that you can customize and manage according to your needs. They offer the familiarity of the software services you're accustomed to, but with enhanced benefits like security and true ownership. Calimero and the Open Web offer a pathway to this new era of digital ownership. Dive into a digital realm where privacy isn't a luxury—it’s a right. + + +## Calimero private shard Calimero private shards are independent networks and do not share validators, execution and state storage. NEAR Protocol is a blockchain that has been built from the ground up to be high-performant, incredibly secure, and infinitely scalable all while supporting sustainability and Calimero shards share all the benefits. @@ -31,7 +38,7 @@ Calimero shards support three main modes of operation: - Permissioned Private Calimero Shard owned by a consortium -- Public Calimero Shard owned by a community +- Community Calimero Shard owned by a community Calimero shards can support up to 200k transactions per second, but a standard one shard deployment has the throughput of 5k transactions per second. diff --git a/sidebars.js b/sidebars.js index 3a575147..e5f86240 100644 --- a/sidebars.js +++ b/sidebars.js @@ -34,6 +34,18 @@ const sidebars = { }, ], }, + { + type: "category", + label: "Community Shard", + collapsible: true, + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "community-shard", + }, + ], + }, { type: "category", label: "Bridge", From 9a66bf3bb2027ddc57d80127c6711a428f9184e9 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Mon, 9 Oct 2023 15:37:46 +0100 Subject: [PATCH 2/3] Update intro.md --- docs/intro.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/intro.md b/docs/intro.md index 771862d4..7e4b62d3 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -21,12 +21,15 @@ Calimero enables you to: - Communicate between your shards and other networks, or between multiple shards (even if the shards are owned by different companies) -## Calimero Open Web +## Calimero X Open Web Calimero is at the forefront of building a more user-centric web: the Open Web. Our goal? To give users, communities, and businesses the tools they need to truly own and control their data. Think of it as having the convenience of popular software services, but hosted by you, where your data stays yours. We've leveraged the power of the NEAR Protocol and the Blockchain Operating System (BOS) to create this platform. With Calimero, you get a private space online where you're in control. It comes equipped with a range of open-source apps that you can customize and manage according to your needs. They offer the familiarity of the software services you're accustomed to, but with enhanced benefits like security and true ownership. Calimero and the Open Web offer a pathway to this new era of digital ownership. Dive into a digital realm where privacy isn't a luxury—it’s a right. +## Calimero X BOS + +The integration of BOS and Calimero accelerates front-end development for both projects. Calimero's private blockchain characteristics ensure data security and ownership. Users can enjoy advanced functionalities, leading to an enhanced Web3 experience. ## Calimero private shard From 16e49ed5a0465a9b90a5463547a407310961b807 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Mon, 9 Oct 2023 15:57:24 +0100 Subject: [PATCH 3/3] Update task.md --- docs/community-shard/task.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/community-shard/task.md b/docs/community-shard/task.md index febe3af9..c747c799 100644 --- a/docs/community-shard/task.md +++ b/docs/community-shard/task.md @@ -1,5 +1,5 @@ --- -title: Docs +title: Task Manager sidebar_label: Task Manager sidebar_position: 4 ---- \ No newline at end of file +---