Skip to content

Commit 231c627

Browse files
authored
chore(docs): add TF API references and examples (#8283)
1 parent fd1bed9 commit 231c627

File tree

28 files changed

+71
-12015
lines changed

28 files changed

+71
-12015
lines changed

docs/content/developer/iota-hierarchies/getting-started/wasm.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,12 @@ export async function createFederation(): Promise<void> {
8787
</Tabs>
8888

8989
See [utils](https://github.com/iotaledger/hierarchies/tree/v0.1/bindings/wasm/hierarchies_wasm/examples/src/util.ts) for details about the implementations about the helper functions used here.
90+
91+
92+
## API Reference
93+
94+
For complete API documentation, see the [WASM API Reference](../references/wasm/api_ref.md).
95+
96+
## Examples
97+
98+
You can find more usage examples and tutorials in the [hierarchies examples repository](https://github.com/iotaledger/hierarchies/tree/v0.1/bindings/wasm/hierarchies_wasm/examples).

docs/content/developer/iota-hierarchies/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags:
99

1010
# Hierarchies
1111

12-
![Hierarchies](/img/banner/banner_hierarchies.svg)
12+
![Hierarchies](/img/banner/banner_hierarchies.png)
1313

1414
## Introduction
1515

docs/content/developer/iota-identity/explanations/decentralized-identifiers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ while facilitating encrypted communication.
2828
A DID is a unique identifier that can be resolved to a DID Document. This document contains data such as public keys, enabling the holder to prove ownership over their personal data, but also URIs that link to public information about the identity. DIDs are the fundamental building blocks of decentralized digital identity.
2929
This implementation complies with the [DID specifications v1.0](https://www.w3.org/TR/did-core//) from the World Wide Web Consortium (W3C).
3030

31-
In the IOTA Identity framework, we have implemented the DID standard according to the `iota` [DID Method Specification](../references/iota-did-method-spec.mdx). Other implementations of DID on IOTA must follow the `iota` DID Method Specification if they want to use the `iota` method name. Libraries implementing the `iota` DID Method Specification are provided for [Rust](../getting-started/rust.mdx) and [WASM](../getting-started/wasm.mdx).
31+
In the IOTA Identity library, we have implemented the DID standard according to the `iota` [DID Method Specification](../references/iota-did-method-spec.mdx). Other implementations of DID on IOTA must follow the `iota` DID Method Specification if they want to use the `iota` method name. Libraries implementing the `iota` DID Method Specification are provided for [Rust](../getting-started/rust.mdx) and [WASM](../getting-started/wasm.mdx).
3232

3333
## Decentralized Identifiers
3434

@@ -113,8 +113,8 @@ while making the data much more trustworthy as it has become verifiable.
113113

114114
## Why Use IOTA Identity Over Other Implementations?
115115

116-
IOTA Identity is a framework to implement Self-Sovereign Identities on IOTA.
117-
Inherently, IOTA provides some unique features that have a major impact on the usability of the framework.
116+
IOTA Identity is a library to implement Self-Sovereign Identities on IOTA.
117+
Inherently, IOTA provides some unique features that have a major impact on the usability of the solution.
118118

119119
### Availability and Accessibility
120120

docs/content/developer/iota-identity/explanations/verifiable-credentials.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515
Verifiable credentials (VCs) are digital statements that can be cryptographically proven, like a digital passport,
1616
and are used within systems to assert certain properties or capabilities of an entity.
1717

18-
In the IOTA Identity framework, this is managed with decentralized identifiers (DIDs) on the IOTA network.
18+
In IOTA Identity, this is managed with decentralized identifiers (DIDs) on the IOTA network.
1919
Subjects and issuers use their DIDs for the creation and verification of credentials.
2020

2121
:::
@@ -56,7 +56,7 @@ See the [Verifiable Credentials Data Model 1.0 Specification](https://w3c.github
5656

5757
## Verifiable Credentials in IOTA
5858

59-
In the IOTA Identity framework, instead of a physical passport being given to Alice and its information written
59+
In IOTA Identity, instead of a physical passport being given to Alice and its information written
6060
into a centralized database owned by the government, Alice receives a digital verifiable credential,
6161
and the information required for verification in the future is written to the network.
6262

docs/content/developer/iota-identity/getting-started/universal-resolver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tags:
1414

1515
# Universal Resolver for IOTA DIDs
1616

17-
The IOTA Identity framework includes a Universal Resolver driver that supports the `did:iota` method. This driver is part of the [Universal Resolver](https://github.com/decentralized-identity/universal-resolver/) infrastructure, which provides a unified interface for resolving DIDs across different methods.
17+
IOTA Identity includes a Universal Resolver driver that supports the `did:iota` method. This driver is part of the [Universal Resolver](https://github.com/decentralized-identity/universal-resolver/) infrastructure, which provides a unified interface for resolving DIDs across different methods.
1818

1919
## Example DIDs
2020

docs/content/developer/iota-identity/getting-started/wasm.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ npm install @iota/identity-wasm@beta
3232

3333
## Build the Library
3434

35-
Alternatively, you can build the bindings to work with currently unreleased features. You can find instructions for this in the [`identity.rs` repository](https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm#build).
35+
Alternatively, you can build the bindings to work with currently unreleased features. You can find instructions for this in the [`identity.rs` repository](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm#build).
3636

3737
## Usage in Node.js and Web
3838

@@ -58,7 +58,7 @@ import { ... } from '@iota/identity/web';
5858

5959

6060
```ts reference
61-
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
61+
https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
6262
```
6363

6464
</TabItem>
@@ -101,7 +101,7 @@ export async function createIdentity(): Promise<void> {
101101
</TabItem>
102102
</Tabs>
103103

104-
See [utils](https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/util.ts) for details about the implementations about the helper functions used here.
104+
See [utils](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/util.ts) for details about the implementations about the helper functions used here.
105105

106106
### Expected Output
107107

@@ -274,6 +274,10 @@ because of that **it will only be slow for the first time**.
274274
275275
*/}
276276

277-
## [API Reference](../references/wasm/api_ref.md)
277+
## API Reference
278278

279-
## [Examples](https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/README.md)
279+
For complete API documentation, see the [WASM API Reference](../references/wasm/api_ref.md).
280+
281+
## Examples
282+
283+
You can find more usage examples and tutorials in the [identity examples repository](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/README.md).

docs/content/developer/iota-identity/how-tos/decentralized-identifiers/create.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This identity consists of many parts that have different functions.
1818

1919
:::note DID method Specification
2020

21-
Note that the IOTA Identity Framework follows [IOTA DID Method Specification](../../references/iota-did-method-spec.mdx).
21+
Note that the IOTA Identity library follows [IOTA DID Method Specification](../../references/iota-did-method-spec.mdx).
2222

2323
:::
2424

docs/content/developer/iota-identity/how-tos/decentralized-identifiers/resolve.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ tags:
1313

1414

1515
DID resolution is the process of fetching and decoding a [DID Document](https://www.w3.org/TR/did-core/#dfn-did-documents) corresponding to a given [DID](https://www.w3.org/TR/did-core/#dfn-decentralized-identifiers).
16-
The [IOTA Identity framework](https://github.com/iotaledger/identity.rs) supports resolving DID Documents that are
16+
The [IOTA Identity library](https://github.com/iotaledger/identity.rs) supports resolving DID Documents that are
1717
stored on an IOTA network and enables users to plug in handlers for additional methods.
1818

1919
This is similar to, but not to be confused with,
2020
the [W3C DID Resolution specification](https://w3c-ccg.github.io/did-resolution/),
2121
which defines function signatures for resolution in the context of web or REST APIs,
22-
whereas the IOTA Identity framework provides strongly-typed resolution for a better developer experience.
22+
whereas the IOTA Identity library provides strongly-typed resolution for a better developer experience.
2323

2424
This functionality is primarily provided by the `Resolver`, which can:
2525

docs/content/developer/iota-identity/how-tos/decentralized-identifiers/update.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ while a service can provide metadata around the identity via URIs.
1919

2020
## Verification Methods
2121

22-
As demonstrated by the [example](#full-example-code) below, the IOTA Identity framework offers easy-to-use methods for adding
22+
As demonstrated by the [example](#full-example-code) below, the IOTA Identity library offers easy-to-use methods for adding
2323
[verification methods](https://www.w3.org/TR/did-core/#verification-methods).
2424

2525
### Properties
2626

2727
You can specify the following properties for a verification method:
2828

2929
- **id**: A [DID URL](https://www.w3.org/TR/did-core/#did-url-syntax) for the verification method. You can specify it by setting the [fragment](https://www.w3.org/TR/did-core/#fragment).
30-
- **type**: Specifies the type of the verification method. The framework supports `Ed25519` and `X25519` key types. This property is automatically filled by the framework when specifying the verification material.
31-
- **publicKeyMultibase**: A multi-base encoded public key which concludes the [verification material](https://www.w3.org/TR/did-core/#verification-material). This can be automatically generated by the framework or manually provided by users.
30+
- **type**: Specifies the type of the verification method. The library supports `Ed25519` and `X25519` key types. This property is automatically filled by the library when specifying the verification material.
31+
- **publicKeyMultibase**: A multi-base encoded public key which concludes the [verification material](https://www.w3.org/TR/did-core/#verification-material). This can be automatically generated by the library or manually provided by users.
3232

3333
## Verification Relationships
3434

@@ -37,7 +37,7 @@ You can use it to specify the purpose of the verification method.
3737

3838
### Relationships
3939

40-
The Identity Framework supports the following relationships:
40+
The Identity Library supports the following relationships:
4141

4242
- **[Authentication](https://www.w3.org/TR/did-core/#authentication)**: Used to specify authentication methods for the DID subject.
4343
- **[Assertion](https://www.w3.org/TR/did-core/#assertion)**: Used to verify verifiable credentials.
@@ -47,7 +47,7 @@ The Identity Framework supports the following relationships:
4747

4848
Verification methods can be either [embedded or referenced](https://www.w3.org/TR/did-core/#referring-to-verification-methods). Referencing verification
4949
methods allows them to be used by more than one verification relationship.
50-
When you create a verification method using the Identity Framework, specifying the `MethodScope` option will result in an embedded verification method.
50+
When you create a verification method using the Identity library, specifying the `MethodScope` option will result in an embedded verification method.
5151
Leaving that option unset will create the verification method as a map entry of the `verificationMethod` property.
5252
You can also add verification relationships afterward using references.
5353

@@ -70,7 +70,7 @@ like authentication, communicating, and discovery.
7070
You can specify the following properties for a service:
7171

7272
- **id**: A [DID URL](https://www.w3.org/TR/did-core/#did-url-syntax) for referencing the service in the DID document. You can specify it by setting the [fragment](https://www.w3.org/TR/did-core/#fragment).
73-
- **type**: A string used to maximize interoperability between services. The framework does not perform any checks on the content of this string.
73+
- **type**: A string used to maximize interoperability between services. The library does not perform any checks on the content of this string.
7474
- **serviceEndpoint**: A URL that points to the service endpoint.
7575

7676
## Create Identity

docs/content/developer/iota-identity/how-tos/key-storage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ However, the recommended default used by IOTA Identity is the `EdDSA` algorithm
9797

9898
## Implementation
9999

100-
The IOTA Identity library ships two implementations of key storage.
100+
IOTA Identity ships two implementations of key storage.
101101
The `JwkMemStore` and `KeyIdMemstore` are insecure in-memory implementations
102102
intended as example implementations and for testing.
103103

0 commit comments

Comments
 (0)