Merge pull request #589 from semaphore-protocol/docs/v3-packages

Specify package version in V3 documentation
semaphore-protocol · Jan 24, 2024 · 1365916 · 1365916
2 parents e293609 + d2ef48e
commit 1365916
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 38 deletions.
diff --git a/...docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/fetching-data.mdx b/...docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/fetching-data.mdx
@@ -28,21 +28,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/data
+npm install @semaphore-protocol/data@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/data
+yarn add @semaphore-protocol/data@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/data
+pnpm add @semaphore-protocol/data@^3
 ```
 
 </TabItem>
@@ -178,4 +178,4 @@ const semaphoreEthers = new SemaphoreEthers("sepolia")
 const members = await semaphoreEthers.getGroupMembers(groupId)
 const group = new Group(groupId, 20, members)
 ```
-:::
+:::
diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/groups.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/groups.mdx
@@ -54,21 +54,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/group
+npm install @semaphore-protocol/group@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/group
+yarn add @semaphore-protocol/group@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/group
+pnpm add @semaphore-protocol/group@^3
 ```
 
 </TabItem>
@@ -156,4 +156,4 @@ Alternativamente, puede utilizar un contrato [`Semaphore.sol`](https://github.co
 
 :::caution
 `Semaphore.sol` incluye un mecanismo para verificar pruebas Semaphore creadas con raíces de árboles de Merkle antiguas. La duración de este mecanismo puede ser definido por el admin en la función `createGroup`. Por lo tanto, los miembros de un grupo pueden continuar generando pruebas válidas incluso después de ser removidos. Para más información ver el issue [#98](https://github.com/semaphore-protocol/semaphore/issues/98).
-:::
+:::
diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/identities.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/identities.mdx
@@ -37,19 +37,19 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/identity
+npm install @semaphore-protocol/identity@^3
 ```
 </TabItem>
 <TabItem value="yarn">
 ```bash
-yarn add @semaphore-protocol/identity
+yarn add @semaphore-protocol/identity@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/identity
+pnpm add @semaphore-protocol/identity@^3
 ```
 
 </TabItem>

diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/proofs.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/proofs.mdx
@@ -43,20 +43,20 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/proof
+npm install @semaphore-protocol/proof@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/proof
+yarn add @semaphore-protocol/proof@^3
 ```
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/proof
+pnpm add @semaphore-protocol/proof@^3
 ```
 
 </TabItem>

diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/quick-setup.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/quick-setup.mdx
@@ -10,13 +10,13 @@ import TabItem from "@theme/TabItem"
 Semaphore ofrece un CLI oficial para configurar su proyecto con Hardhat. Si su NPM es versión 5.2 or más reciente puede utilizar NPX:
 
 ```bash
-npx @semaphore-protocol/cli@latest create my-app --template monorepo-ethers
+npx @semaphore-protocol/cli@^3 create my-app --template monorepo-ethers
 ```
 
-De lo contrario, instale `@semaphore-protocol/cli` de forma global y corra el comando `init`:
+De lo contrario, instale `@semaphore-protocol/cli@^3` de forma global y corra el comando `init`:
 
 ```bash
-npm i -g @semaphore-protocol/cli@latest
+npm i -g @semaphore-protocol/cli@^3
 semaphore create my-app --template monorepo-ethers
 ```
 
@@ -333,4 +333,4 @@ pnpm dev
 ```
 
 </TabItem>
-</Tabs>
+</Tabs>
diff --git a/apps/docs/versioned_docs/version-V3/guides/fetching-data.mdx b/apps/docs/versioned_docs/version-V3/guides/fetching-data.mdx
@@ -28,21 +28,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/data
+npm install @semaphore-protocol/data@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/data
+yarn add @semaphore-protocol/data@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/data
+pnpm add @semaphore-protocol/data@^3
 ```
 
 </TabItem>
@@ -178,4 +178,4 @@ const semaphoreEthers = new SemaphoreEthers("sepolia")
 const members = await semaphoreEthers.getGroupMembers(groupId)
 const group = new Group(groupId, 20, members)
 ```
-:::
+:::
diff --git a/apps/docs/versioned_docs/version-V3/guides/groups.mdx b/apps/docs/versioned_docs/version-V3/guides/groups.mdx
@@ -54,21 +54,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/group
+npm install @semaphore-protocol/group@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/group
+yarn add @semaphore-protocol/group@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/group
+pnpm add @semaphore-protocol/group@^3
 ```
 
 </TabItem>
@@ -156,4 +156,4 @@ Alternatively, you can use an already deployed [`Semaphore.sol`](https://github.
 
 :::caution
 `Semaphore.sol` includes a mechanism to verify Semaphore proofs created with old Merkle tree roots, the duration of which can be defined by the admin in the `createGroup` function. Members of a group could then continue to generate valid proofs even after being removed. For more info see the issue [#98](https://github.com/semaphore-protocol/semaphore/issues/98).
-:::
+:::
diff --git a/apps/docs/versioned_docs/version-V3/guides/identities.mdx b/apps/docs/versioned_docs/version-V3/guides/identities.mdx
@@ -37,21 +37,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/identity
+npm install @semaphore-protocol/identity@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/identity
+yarn add @semaphore-protocol/identity@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/identity
+pnpm add @semaphore-protocol/identity@^3
 ```
 
 </TabItem>
@@ -116,4 +116,4 @@ To reuse the saved identity, pass the JSON to the `Identity()` constructor.
 
 ```ts
 const identity2 = new Identity(identity.toString())
-```
+```
diff --git a/apps/docs/versioned_docs/version-V3/guides/proofs.mdx b/apps/docs/versioned_docs/version-V3/guides/proofs.mdx
@@ -43,21 +43,21 @@ values={[
 <TabItem value="npm">
 
 ```bash
-npm install @semaphore-protocol/proof
+npm install @semaphore-protocol/proof@^3
 ```
 
 </TabItem>
 <TabItem value="yarn">
 
 ```bash
-yarn add @semaphore-protocol/proof
+yarn add @semaphore-protocol/proof@^3
 ```
 
 </TabItem>
 <TabItem value="pnpm">
 
 ```bash
-pnpm add @semaphore-protocol/proof
+pnpm add @semaphore-protocol/proof@^3
 ```
 
 </TabItem>
@@ -126,4 +126,4 @@ To verify Semaphore proofs in your contract, import `ISemaphore.sol`, pass it th
 
 :::info
 You can import `ISemaphore.sol` and other Semaphore contracts from the [`@semaphore-protocol/contracts`](https://github.com/semaphore-protocol/semaphore/tree/main/packages/contracts) NPM module.
-:::
+:::
diff --git a/apps/docs/versioned_docs/version-V3/quick-setup.mdx b/apps/docs/versioned_docs/version-V3/quick-setup.mdx
@@ -10,13 +10,13 @@ import TabItem from "@theme/TabItem"
 Semaphore provides an official CLI to set up your project with Hardhat. If your NPM version is 5.2 or higher you can use NPX:
 
 ```bash
-npx @semaphore-protocol/cli@latest create my-app --template monorepo-ethers
+npx @semaphore-protocol/cli@^3 create my-app --template monorepo-ethers
 ```
 
-Otherwise, install `@semaphore-protocol/cli` globally and run the `create` command:
+Otherwise, install `@semaphore-protocol/cli@^3` globally and run the `create` command:
 
 ```bash
-npm i -g @semaphore-protocol/cli@latest
+npm i -g @semaphore-protocol/cli@^3
 semaphore create my-app --template monorepo-ethers
 ```
 
@@ -333,4 +333,4 @@ pnpm dev
 ```
 
 </TabItem>
-</Tabs>
+</Tabs>