Skip to content

docs: fix links to docs.rs #125

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.

Sign up for GitHub

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

Merged
altkdf merged 1 commit into from
May 27, 2025
Merged

docs: fix links to docs.rs #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Please share your feedback on the [developer forum](https://forum.dfinity.org/t/

Tools to help canister developers integrate vetKeys into their Internet Computer (ICP) applications.

- **[KeyManager](https://docs.rs/ic-vetkeys/latest/key_manager/struct.KeyManager.html)** – a library for deriving and managing encrypted cryptographic keys.
- **[EncryptedMaps](https://docs.rs/ic-vetkeys/latest/encrypted_maps/struct.EncryptedMaps.html)** – a library for encrypting using vetkeys, and securely storing and sharing encrypted key-value pairs.
- **[KeyManager](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/key_manager/struct.KeyManager.html)** – a library for deriving and managing encrypted cryptographic keys.
- **[EncryptedMaps](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/encrypted_maps/struct.EncryptedMaps.html)** – a library for encrypting using vetkeys, and securely storing and sharing encrypted key-value pairs.
- **[Utils](https://docs.rs/ic-vetkeys/latest/)** – Utility functions for working with vetKeys.

### **2. [vetKeys Frontend Library](./frontend/ic_vetkeys)** - Supports frontend developers
Expand Down
4 changes: 2 additions & 2 deletions backend/rs/ic_vetkeys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

This crate contains a set of tools designed to help canister developers integrate **vetKeys** into their Internet Computer (ICP) applications.

## [Key Manager](https://docs.rs/ic-vetkeys/latest/key_manager/struct.KeyManager.html)
## [Key Manager](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/key_manager/struct.KeyManager.html)
A canister library for derivation of encrypted vetkeys from arbitrary strings. It can be used in combination with the [frontend key manager library](https://dfinity.github.io/vetkeys/classes/_dfinity_vetkeys_key_manager.KeyManager.html).

## [Encrypted Maps](https://docs.rs/ic-vetkeys/latest/encrypted_maps/struct.EncryptedMaps.html)
## [Encrypted Maps](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/encrypted_maps/struct.EncryptedMaps.html)
An efficient canister library facilitating access control and encrypted storage for a collection of maps contatining key-value pairs. It can be used in combination with the [frontend encrypted maps library](https://dfinity.github.io/vetkeys/classes/_dfinity_vetkeys_encrypted_maps.EncryptedMaps.html).

## [Utils](https://docs.rs/ic-vetkeys/latest/)
Expand Down
4 changes: 2 additions & 2 deletions frontend/ic_vetkeys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Provides frontend utilities for the low-level use of VetKeys such as decryption

---

A frontend library facilitating communication with a [key manager enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
A frontend library facilitating communication with a [key manager enabled canister](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/key_manager/struct.KeyManager.html).

<br>

[`ic_vetkeys/encrypted_maps`](https://dfinity.github.io/vetkeys/modules/_dfinity_vetkeys_encrypted_maps.html)

---

A frontend library facilitating communication with an [encrypted maps enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
A frontend library facilitating communication with an [encrypted maps enabled canister](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/encrypted_maps/struct.EncryptedMaps.html).
2 changes: 1 addition & 1 deletion frontend/ic_vetkeys/src/encrypted_maps/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export type {
} from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";

/**
* The **EncryptedMaps** frontend library facilitates interaction with an **EncryptedMaps-enabled canister** on the **Internet Computer (ICP)**.
* The **EncryptedMaps** frontend library facilitates interaction with an [**EncryptedMaps-enabled canister**](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/encrypted_maps/struct.EncryptedMaps.html) on the **Internet Computer (ICP)**.
* It allows web applications to securely store, retrieve, and manage encrypted key-value pairs within named maps while handling user access control and key sharing.
*
* ## Core Features
Expand Down
2 changes: 1 addition & 1 deletion frontend/ic_vetkeys/src/key_manager/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export type {
} from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";

/**
* The **`KeyManager`** frontend library facilitates interaction with a [**`KeyManager`-enabled canister**](https://docs.rs/ic_vetkeys/latest/TODO) on the **Internet Computer (ICP)**.
* The **`KeyManager`** frontend library facilitates interaction with a [**`KeyManager`-enabled canister**](https://docs.rs/ic-vetkeys/latest/ic_vetkeys/key_manager/struct.KeyManager.html) on the **Internet Computer (ICP)**.
* It allows web applications to securely request, decrypt, and manage VetKeys while handling access control and key sharing.
*
* ## Core Features
Expand Down