Skip to content

Commit 3116d9b

Browse files
committed
fix: standardize capitalization in documentation headers and section titles
1 parent a2c9e78 commit 3116d9b

File tree

11 files changed

+23
-23
lines changed

11 files changed

+23
-23
lines changed

src/use-iapp/how-to-pay/how-to-pay-for-web3telegram.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
methods for secure Telegram communication.
66
---
77

8-
# How to pay for Web3telegram
8+
# How to Pay for Web3Telegram
99

1010
[Web3Telegram](../web3telegram) dev tool offers secure, blockchain-based
1111
communication by encrypting emails and protecting user privacy.
@@ -55,7 +55,7 @@ remaining balance is automatically deducted from your account.
5555
For additional information on using xRLC for fallback payment in Web3Telegram,
5656
refer to the **Using xRLC with Web3Telegram** section.
5757

58-
### Step 4: Execute Web3Telegram's sendTelegram Function
58+
### Step 4: Execute Web3Telegram's `sendTelegram` Function
5959

6060
When using a voucher for payment, set the `useVoucher` parameter to `true`:
6161

@@ -79,7 +79,7 @@ const sendTelegram = await web3telegram.sendTelegram({
7979
});
8080
```
8181

82-
## Using xRlC for Web3Telegram
82+
## Using xRLC for Web3Telegram
8383

8484
If you choose to use xRLC to cover the computational cost of Web3Telegram (or if
8585
you need to cover data access costs such as retrieving the recipient's Chat Id),
@@ -138,7 +138,7 @@ Use the command below to check your balance:
138138
iexec.account.show();
139139
```
140140

141-
### Execute sendTelegram
141+
### Execute `sendTelegram`
142142

143143
Set the `useVoucher` parameter to `false` when using Web3Telegram's sendTelegram
144144
function to pay with xRLC:

src/use-iapp/web3mail/advanced-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
communication.
66
---
77

8-
# Advanced configuration
8+
# Advanced Configuration
99

1010
The `IExecWeb3mail` constructor accepts configuration options object. As these
1111
options are very specific, you won't need to use them for a standard usage of

src/use-iapp/web3mail/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If you use it with **Webpack**, some polyfills will be needed. You can find a
4949
working project
5050
[here](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/demo/browser-webpack).
5151

52-
### Instantiate with a Web3 provider
52+
### Instantiate with a Web3 Provider
5353

5454
::: code-group
5555

@@ -78,7 +78,7 @@ const web3mail = new IExecWeb3mail(web3Provider);
7878

7979
:::
8080

81-
### Instantiate without a Web3 provider
81+
### Instantiate Without a Web3 Provider
8282

8383
For projects that only require read functions, you can instantiate the SDK
8484
without a Web3 provider.

src/use-iapp/web3mail/methods/fetchMyContacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ const contactsList = await web3mail.fetchMyContacts({
5353
});
5454
```
5555

56-
## Return value
56+
## Return Value
5757

5858
The result object contains a list of `contact` objects. Each `contact`
5959
represents one user who previously granted you authorization to send them

src/use-iapp/web3mail/methods/fetchUserContacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const contactsList = await web3mail.fetchUserContacts({
7373
});
7474
```
7575

76-
## Return value
76+
## Return Value
7777

7878
The result object contains a list of `contact` objects. Each `contact`
7979
represents one user who previously granted authorization for the user identified

src/use-iapp/web3mail/methods/sendEmail.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ const sendEmail = await web3mail.sendEmail({
308308
});
309309
```
310310

311-
## Return value
311+
## Return Value
312312

313313
```ts twoslash
314314
import { type SendEmailResponse } from '@iexec/web3mail';
@@ -322,9 +322,9 @@ This uniquely identifies the email task on the iExec side chain. You can view
322322
the status of the `sendEmail` method by monitoring the task on the
323323
[iExec Explorer](https://explorer.iex.ec/bellecour).
324324

325-
## Error handling
325+
## Error Handling
326326

327-
### Validation errors
327+
### Validation Errors
328328

329329
We use [yup](https://github.com/jquense/yup) to validate input parameters.
330330

@@ -352,7 +352,7 @@ try {
352352
}
353353
```
354354

355-
### Email schema error
355+
### Email Schema Error
356356

357357
To be able to send an email to a protected data, it needs to contain, well, an
358358
email address.
@@ -366,7 +366,7 @@ If not, you'll get a `WorkflowError` in the form of:
366366
}
367367
```
368368

369-
### iExec protocol errors
369+
### iExec Protocol Errors
370370

371371
In case the iExec stack is to blame, we'll make it clear and you'll get a
372372
specific `WorkflowError`:
@@ -379,7 +379,7 @@ specific `WorkflowError`:
379379
}
380380
```
381381

382-
### Workflow errors
382+
### Workflow Errors
383383

384384
For any other errors, you'll get a `WorkflowError` error in the form of:
385385

src/use-iapp/web3telegram/advanced-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
for secure Telegram communication on the iExec blockchain.
66
---
77

8-
# Advanced configuration
8+
# Advanced Configuration
99

1010
The `IExecWeb3Telegram` constructor accepts configuration options object. As
1111
these options are very specific, you won't need to use them for a standard usage

src/use-iapp/web3telegram/integration-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The integration process consists of the following steps:
2121
messages.**
2222
4. **Send messages securely using the Web3Telegram SDK.**
2323

24-
## 1. Get your users to retrieve their chat ID
24+
## 1. Get your Users to Retrieve their Chat ID
2525

2626
To enable messaging via Web3Telegram, you need to retrieve the recipient's Chat
2727
ID.
@@ -48,7 +48,7 @@ senders** can contact you.
4848

4949
:::
5050

51-
## 2. Create the protected data with data protector SDK
51+
## 2. Create the Protected Data with Data Protector SDK
5252

5353
After obtaining your user's Chat ID, you need to protect it using iExec’s Data
5454
Protector to ensure privacy and security.
@@ -64,7 +64,7 @@ const protectedData = await dataProtectorCore.protectData({
6464
});
6565
```
6666

67-
## 3. Grant access via data protector SDK
67+
## 3. Grant Access via Data Protector SDK
6868

6969
To allow users to send messages, you must explicitly grant access to specific
7070
users.
@@ -85,7 +85,7 @@ const grantedAccess = await dataProtectorCore.grantAccess({
8585
});
8686
```
8787

88-
## 4. Send messages via Web3Telegram SDK
88+
## 4. Send Messages via Web3Telegram SDK
8989

9090
Once authorized, a user can send messages via Web3Telegram SDK.
9191

src/use-iapp/web3telegram/methods/fetchMyContacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ const contactsList = await web3telegram.fetchMyContacts({
5353
});
5454
```
5555

56-
## Return value
56+
## Return Value
5757

5858
The result object contains a list of `contact` objects. Each `contact`
5959
represents one user who previously granted you authorization to send them

src/use-iapp/web3telegram/methods/fetchUserContacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const contactsList = await web3telegram.fetchUserContacts({
7373
});
7474
```
7575

76-
## Return value
76+
## Return Value
7777

7878
The result object contains a list of `contact` objects. Each `contact`
7979
represents one user who previously granted authorization for the user identified

0 commit comments

Comments
 (0)