Skip to content

Commit ee19b14

Browse files
authored
chore: fix an amount of broken links (#120)
* fix links * links * fx links * Update notes.md * links * links * links * fix link * Update import.md * Update export.md * fix link * fix links * fix link * fix link * fix link
1 parent bfdf0a8 commit ee19b14

12 files changed

Lines changed: 70 additions & 67 deletions

File tree

versioned_docs/version-0.12/miden-client/web-client/accounts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ try {
7474

7575
For more detailed information about the classes and methods used in these examples, refer to the following API documentation:
7676

77-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
78-
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
79-
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
77+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
78+
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
79+
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
8080

81-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
81+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

versioned_docs/version-0.12/miden-client/web-client/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The examples in this section showcase various capabilities of the Miden SDK, inc
3333
- Working with consumable notes
3434
- Send and fetch private notes using the note transport network
3535

36-
For installation instructions, prerequisites, and setup details, please refer to the [SDK README](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
36+
For installation instructions, prerequisites, and setup details, please refer to the [SDK README](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
3737

3838
Each example is self-contained and includes:
3939

versioned_docs/version-0.12/miden-client/web-client/export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,6 @@ The store export contains all the data managed by the client, which can be usefu
8888

8989
For more detailed information about the export functionality, refer to the following API documentation:
9090

91-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
91+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
9292

93-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
93+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

versioned_docs/version-0.12/miden-client/web-client/import.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The `forceImportStore` method is a destructive operation that will completely ov
104104

105105
For more detailed information about the import functionality, refer to the following API documentation:
106106

107-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
108-
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class returned by importPublicAccountFromSeed
107+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
108+
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class returned by importPublicAccountFromSeed
109109

110-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
110+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

versioned_docs/version-0.12/miden-client/web-client/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ npm install @demox-labs/miden-sdk
3737
yarn add @demox-labs/miden-sdk
3838
```
3939

40-
See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state.
40+
See the [README](https://github.com/0xMiden/miden-client/blob/main/crates/web-client/README.md) for full installation instructions and some usage instructions, including code examples for wallet creation, transaction execution, and syncing state.

versioned_docs/version-0.12/miden-client/web-client/new-accounts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ try {
8181
For more detailed information about the classes and methods used in these examples, refer to the following API documentation:
8282

8383
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for interacting with the Miden network
84-
- [Account](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
85-
- [AccountStorageMode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountStorageMode.md) - Storage mode options and methods
86-
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
87-
- [AccountCode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountCode.md) - Account code management
88-
- [AccountStorage](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountStorage.md) - Account storage operations
84+
- [Account](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Account.md) - Account class and its properties
85+
- [AccountStorageMode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountStorageMode.md) - Storage mode options and methods
86+
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Account identifier class and utilities
87+
- [AccountCode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountCode.md) - Account code management
88+
- [AccountStorage](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountStorage.md) - Account storage operations
8989

90-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
90+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

versioned_docs/version-0.12/miden-client/web-client/new-transactions.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -269,22 +269,22 @@ Custom transactions require a good understanding of the Miden VM and its instruc
269269

270270
For more detailed information about transaction functionality, refer to the following API documentation:
271271

272-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for transaction operations
273-
- [TransactionRequest](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionRequest.md) - Class representing transaction requests
274-
- [TransactionRequestBuilder](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionRequestBuilder.md) - Builder class for creating transaction requests
275-
- [TransactionResult](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionResult.md) - Class representing transaction execution results
276-
- [TransactionProver](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionProver.md) - Class for transaction proving
277-
- [TransactionScript](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionScript.md) - Class for defining transaction scripts
278-
- [NoteType](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteType.md) - Enumeration for note types (Private/Public)
279-
- [NoteAssets](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteAssets.md) - Class for defining note assets
280-
- [NoteMetadata](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteMetadata.md) - Class for defining note metadata
281-
- [FungibleAsset](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/FungibleAsset.md) - Class for defining fungible assets
282-
- [Felt](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Felt.md) - Class for working with field elements
283-
- [FeltArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/FeltArray.md) - Class for working with arrays of field elements
284-
- [NoteTag](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteTag.md) - Class for defining note tags
285-
- [NoteExecutionMode](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteExecutionMode.md) - Class for defining note execution modes
286-
- [NoteExecutionHint](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteExecutionHint.md) - Class for defining note execution hints
287-
- [OutputNotesArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/OutputNotesArray.md) - Class for working with arrays of output notes
288-
- [NotesArray](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NotesArray.md) - Class for working with arrays of notes
289-
290-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
272+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for transaction operations
273+
- [TransactionRequest](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionRequest.md) - Class representing transaction requests
274+
- [TransactionRequestBuilder](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionRequestBuilder.md) - Builder class for creating transaction requests
275+
- [TransactionResult](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionResult.md) - Class representing transaction execution results
276+
- [TransactionProver](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionProver.md) - Class for transaction proving
277+
- [TransactionScript](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionScript.md) - Class for defining transaction scripts
278+
- [NoteType](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteType.md) - Enumeration for note types (Private/Public)
279+
- [NoteAssets](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteAssets.md) - Class for defining note assets
280+
- [NoteMetadata](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteMetadata.md) - Class for defining note metadata
281+
- [FungibleAsset](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/FungibleAsset.md) - Class for defining fungible assets
282+
- [Felt](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Felt.md) - Class for working with field elements
283+
- [FeltArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/FeltArray.md) - Class for working with arrays of field elements
284+
- [NoteTag](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteTag.md) - Class for defining note tags
285+
- [NoteExecutionMode](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteExecutionMode.md) - Class for defining note execution modes
286+
- [NoteExecutionHint](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteExecutionHint.md) - Class for defining note execution hints
287+
- [OutputNotesArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/OutputNotesArray.md) - Class for working with arrays of output notes
288+
- [NotesArray](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NotesArray.md) - Class for working with arrays of notes
289+
290+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).

versioned_docs/version-0.12/miden-client/web-client/note-transport.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ try {
8383

8484
For more detailed information about note transport functionality, refer to the following API documentation:
8585

86-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note transport operations
87-
- [Note](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Note.md) - Class for working with notes
88-
- [Address](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/Address.md) - Class for working with addresses
89-
- [NoteFilter](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
90-
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
86+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note transport operations
87+
- [Note](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Note.md) - Class for working with notes
88+
- [Address](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/Address.md) - Class for working with addresses
89+
- [NoteFilter](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
90+
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
9191

92-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
92+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
9393

versioned_docs/version-0.12/miden-client/web-client/notes.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,15 +123,15 @@ try {
123123

124124
For more detailed information about note functionality, refer to the following API documentation:
125125

126-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note operations
127-
- [NoteFilter](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
128-
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
129-
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
130-
- [InputNoteRecord](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/InputNoteRecord.md) - Class representing input notes
131-
- [ConsumableNoteRecord](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/ConsumableNoteRecord.md) - Class representing consumable notes
132-
- [NoteScript](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteScript.md) - Class for working with note scripts
126+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for note operations
127+
- [NoteFilter](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteFilter.md) - Class for filtering notes
128+
- [NoteFilterTypes](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/enumerations/NoteFilterTypes.md) - Enumeration for note filter types
129+
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
130+
- [InputNoteRecord](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/InputNoteRecord.md) - Class representing input notes
131+
- [ConsumableNoteRecord](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/ConsumableNoteRecord.md) - Class representing consumable notes
132+
- [NoteScript](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteScript.md) - Class for working with note scripts
133133

134-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).
134+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
135135

136136
### Available Note Filter Types
137137

@@ -159,3 +159,4 @@ const noteIds = [noteId1, noteId2];
159159
const listFilter = new NoteFilter(NoteFilterTypes.List, noteIds);
160160
const specificNotes = await webClient.getInputNotes(listFilter);
161161
```
162+

versioned_docs/version-0.12/miden-client/web-client/sync.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,11 @@ The `SyncSummary` object returned by `syncState()` contains the following inform
4545

4646
For more detailed information about sync functionality, refer to the following API documentation:
4747

48-
- [WebClient](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/WebClient.md) - Main client class for sync operations
49-
- [SyncSummary](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/SyncSummary.md) - Class representing sync state
50-
- [NoteId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/NoteId.md) - Class for working with note IDs
51-
- [AccountId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
52-
- [TransactionId](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/classes/TransactionId.md) - Class for working with transaction IDs
48+
- [WebClient](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/WebClient.md) - Main client class for sync operations
49+
- [SyncSummary](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/SyncSummary.md) - Class representing sync state
50+
- [NoteId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/NoteId.md) - Class for working with note IDs
51+
- [AccountId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/AccountId.md) - Class for working with account IDs
52+
- [TransactionId](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/classes/TransactionId.md) - Class for working with transaction IDs
53+
54+
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/blob/main/docs/typedoc/web-client/README.md).
5355

54-
For a complete list of available classes and utilities, see the [SDK API Reference](https://github.com/0xMiden/miden-client/docs/typedoc/web-client/README.md).

0 commit comments

Comments
 (0)