diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0567cdae..86eded49 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ We use [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to kee ### Commits -We use [Conventional Commits](https://www.conventionalcommits.org) to add human and machine readable meaning to our commit messages. In particular, we use the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). +We use [Conventional Commits](https://www.conventionalcommits.org) to add human and machine-readable meaning to our commit messages. In particular, we use the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). Don't worry if it looks complicated. In our repositories, after adding your files with git (i.e `git add`), you can just run the `commit` script in our `package.json`, and you'll be prompted to fill out any required commit fields at commit time. We use [Commitizen](https://github.com/commitizen/cz-cli) under the hood. @@ -76,7 +76,7 @@ The type must be one of the following: #### Scope -The scope could be anything specifying place of the commit change. In a monorepo, it could be the name of the package or project affected. +The scope could be anything specifying the place of the commit change. In a monorepo, it could be the name of the package or project affected. #### Subject diff --git a/README.md b/README.md index aa3749ac..a2cc2cd6 100644 --- a/README.md +++ b/README.md @@ -328,7 +328,7 @@ yarn prettier:write ### Conventional commits -Bandada uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), which follow a standardised format for commit messages. To use this format, you can run the [command line utility](https://github.com/commitizen/cz-cli) by running: +Bandada uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), which follow a standardized format for commit messages. To use this format, you can run the [command line utility](https://github.com/commitizen/cz-cli) by running: ```bash yarn commit diff --git a/apps/docs/README.md b/apps/docs/README.md index 0c6c2c27..cd08b498 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -38,4 +38,4 @@ Not using SSH: $ GIT_USER= yarn deploy ``` -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push it to the `gh-pages` branch. diff --git a/apps/docs/docs/api-sdk.md b/apps/docs/docs/api-sdk.md index 9bd13bdf..888385e9 100644 --- a/apps/docs/docs/api-sdk.md +++ b/apps/docs/docs/api-sdk.md @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem" [The API SDK JavaScript package](https://github.com/bandada-infra/bandada/tree/main/libs/api-sdk) provides a list of functions to make it easier to work with the Bandada API. -Example of project using the API SDK library: [bandada-api-sdk-demo](https://github.com/bandada-infra/bandada-sdk-demo). +Example of a project using the API SDK library: [bandada-api-sdk-demo](https://github.com/bandada-infra/bandada-sdk-demo). ## Install library @@ -500,4 +500,4 @@ const url = apiSdk.getMultipleCredentialsGroupJoinUrl( groupId, commitment ) -``` \ No newline at end of file +``` diff --git a/apps/docs/docs/tutorials/api-sdk/onchain-invites.md b/apps/docs/docs/tutorials/api-sdk/onchain-invites.md index feff398a..5212d7ca 100644 --- a/apps/docs/docs/tutorials/api-sdk/onchain-invites.md +++ b/apps/docs/docs/tutorials/api-sdk/onchain-invites.md @@ -68,12 +68,12 @@ const { data: signer } = useSigner() const semaphore = getSemaphoreContract("sepolia", signer) ``` -You can choose to use other signer package of your choice, wagmi is just an example. +You can choose to use another signer package of your choice, wagmi is just an example. ## Create a group -Create a new on-chain group with associated group. +Create a new on-chain group with an associated group. ```ts const semaphore = getSemaphoreContract("sepolia", signer as any) @@ -159,7 +159,7 @@ const memberId = "member-id-1" const groupCreationDetails = { name: onchainGroupId, - description: `This group is associated to the on-chain group ${onchainGroupId}`, + description: `This group is associated with the on-chain group ${onchainGroupId}`, treeDepth: 16, fingerprintDuration: 3600 } @@ -180,4 +180,4 @@ if(invite.isRedeemed) { // redeem the invite code after successfully adding the member to the on-chain group await apiSdk.redeemInvite(invite.code, associatedGroup.id, apiKey) } -``` \ No newline at end of file +``` diff --git a/apps/docs/docs/tutorials/dashboard/off-chain/credential.md b/apps/docs/docs/tutorials/dashboard/off-chain/credential.md index b843e832..303022b0 100644 --- a/apps/docs/docs/tutorials/dashboard/off-chain/credential.md +++ b/apps/docs/docs/tutorials/dashboard/off-chain/credential.md @@ -31,7 +31,7 @@ title: Credential access **Input**: Minimum balance, network, block number. - **Provider**: EAS. - **Credential**: Attestations. - **Input**: Minimum attestations, network, attestation details. + **Input**: Minimum attestations, network, and attestation details. 3. Click `Continue` to proceed. 4. You will be redirected to the `Group Preview` page to review the group details. @@ -39,4 +39,4 @@ title: Credential access ![Create off-chain group preview](../../../../static/img/tutorial/offchain-preview.png) -Congratulations! You have successfully created an off-chain credential access group! \ No newline at end of file +Congratulations! You have successfully created an off-chain credential access group! diff --git a/apps/docs/docs/tutorials/dashboard/off-chain/multiple-credentials.md b/apps/docs/docs/tutorials/dashboard/off-chain/multiple-credentials.md index 9541a6d0..f05b2252 100644 --- a/apps/docs/docs/tutorials/dashboard/off-chain/multiple-credentials.md +++ b/apps/docs/docs/tutorials/dashboard/off-chain/multiple-credentials.md @@ -3,7 +3,7 @@ sidebar_position: 4 title: Multiple credentials access --- -# Muleiple credentials access +# Multiple credentials access ## Create an off-chain group with multiple credentials access @@ -11,7 +11,7 @@ title: Multiple credentials access ![Create off-chain group multiple credentials access](../../../../static/img/tutorial/offchain-mult-credentials.png) -2. You can select multiple types of credentials for the off-chain group so that only users that fit the criteria can join the group. Users can use parentheses and logical operators such as `AND`, `OR`, `NOT` and `XOR` to chain multiple credentials together. Currently supported credentials and providers are: +2. You can select multiple types of credentials for the off-chain group so that only users who fit the criteria can join the group. Users can use parentheses and logical operators such as `AND`, `OR`, `NOT`, and `XOR` to chain multiple credentials together. Currently supported credentials and providers are: - **Provider**: GitHub. - **Credential**: Followers. **Input**: Minimum followers. @@ -31,11 +31,11 @@ title: Multiple credentials access **Input**: Minimum balance, network, block number. - **Provider**: EAS. - **Credential**: Attestations. - **Input**: Minimum attestations, network, attestation details. + **Input**: Minimum attestations, network, and attestation details. 4. Click `Continue` to proceed. 5. You will be redirected to the `Group Preview` page to review the group details. 6. Click `Create Group` to finalize the group creation. ![Create off-chain group preview](../../../../static/img/tutorial/offchain-preview.png) -Congratulations! You have successfully created an off-chain multiple credentials access group! \ No newline at end of file +Congratulations! You have successfully created an off-chain multiple credentials access group! diff --git a/apps/docs/docs/tutorials/dashboard/on-chain/onchain.md b/apps/docs/docs/tutorials/dashboard/on-chain/onchain.md index ecfc10cd..e90e0c40 100644 --- a/apps/docs/docs/tutorials/dashboard/on-chain/onchain.md +++ b/apps/docs/docs/tutorials/dashboard/on-chain/onchain.md @@ -13,9 +13,9 @@ title: Create group 2. Unlike an off-chain group, you do not have to input any group details to create an on-chain group. 3. Click on `Continue` to proceed. -4. You will be redirected to the `Group Preview` page to reivew the group details. +4. You will be redirected to the `Group Preview` page to review the group details. 5. Click `Create Group` to finalize the group creation. ![Create on-chain group preview](../../../../static/img/tutorial/onchain-preview.png) -Congratulations! You have successfully created an on-chain group! \ No newline at end of file +Congratulations! You have successfully created an on-chain group! diff --git a/apps/website/app/learn/page.mdx b/apps/website/app/learn/page.mdx index 007958cd..b65e854b 100644 --- a/apps/website/app/learn/page.mdx +++ b/apps/website/app/learn/page.mdx @@ -53,7 +53,7 @@ import { ArticlesAndVideos } from "./../sections/learn/ArticlesAndVideos" In the realm of privacy and zero-knowledge technologies, the concept of a group takes on a significant role. A group, in this context, is more than just a collection of individuals; it represents an **anonymity set**. This means that within the group, individual members' actions, characteristics, or identities become indistinguishable from one another, providing a way for individuals to engage in collective actions or share attributes without revealing specific information about themselves. - + Anonymity refers to the complete concealment of a user's identity, while pseudonymity allows users to interact under a consistent but “disguised” identity.