Skip to content

Commit cb2c7b6

Browse files
committed
Refactor documentation for improved readability and consistency
- Adjusted formatting in various guides to enhance clarity, including breaking long lines for better readability. - Updated links to ensure they point to the correct paths and maintain consistency across documentation. - Improved navigation by restructuring content in the iApp and DataProtector sections.
1 parent 93e8770 commit cb2c7b6

File tree

7 files changed

+17
-14
lines changed

7 files changed

+17
-14
lines changed

src/get-started/overview/what-is-iapp.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ guarantees** that privacy is preserved within the TEE execution environment.
152152

153153
## Next Steps
154154

155-
Ready to build your first privacy-preserving application? Start with our [Hello World tutorial](/get-started/helloWorld) or dive into the [iApp Generator documentation](/references/iapp-generator).
155+
Ready to build your first privacy-preserving application? Start with our
156+
[Hello World tutorial](/get-started/helloWorld) or dive into the
157+
[iApp Generator documentation](/references/iapp-generator).
156158

157-
For more technical details, see the [DataProtector Sharing](/references/dataProtector/dataProtectorSharing) documentation.
159+
For more technical details, see the
160+
[DataProtector Sharing](/references/dataProtector/dataProtectorSharing)
161+
documentation.

src/get-started/protocol/worker/manage-access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ The supported tags for workerpool orders are:
6868

6969
1. Do not publish workerpool orders with a tag value out of the specified list.
7070
Such an order could produce undesirable and unpredictable behaviors. The
71-
[iExec SDK](/references/sdk) implements all required preflight checks to avoid
72-
erroneous orders publishing.
71+
[iExec SDK](/references/sdk) implements all required preflight checks to
72+
avoid erroneous orders publishing.
7373
2. Currently, TEE workflow do not support tasks replication on several workers.
7474
TEE workerpool orders must be published with `trust` value equal to `1`.
7575
3. TEE tasks with Gramine TEE framework are not supported yet. Do not publish

src/guides/build-iapp/how-to-get-and-decrypt-results.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,5 +311,4 @@ Integrate result handling into your applications:
311311

312312
- **[DataProtector SDK](/references/dataProtector)** - Complete SDK
313313
documentation
314-
- **[SDK Deep Dive](/references/sdk)** - Advanced result handling
315-
techniques
314+
- **[SDK Deep Dive](/references/sdk)** - Advanced result handling techniques

src/guides/build-iapp/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ After mastering these guides, explore:
3535

3636
- **[iApp Generator](/references/iapp-generator)** - Complete development
3737
toolkit
38-
- **[What is an iApp?](/get-started/overview/what-is-iapp)** - Core
39-
concepts and TEE overview
38+
- **[What is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and
39+
TEE overview
4040

4141
Ready to build your first privacy-preserving application? Start with the
4242
[Build & Deploy](/guides/build-iapp/build-&-deploy) guide!

src/guides/use-iapp/how-to-pay/how-to-pay-for-web3mail.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ description:
77

88
# How to Pay for Web3Mail
99

10-
[Web3Mail](/references/web3mail) dev tool offers secure, blockchain-based communication
11-
by encrypting emails and protecting user privacy.
10+
[Web3Mail](/references/web3mail) dev tool offers secure, blockchain-based
11+
communication by encrypting emails and protecting user privacy.
1212

1313
The `sendEmail` function uses confidential computing power to encrypt and send
1414
messages, ensuring secure and decentralized email exchanges.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ description:
88

99
# How to Pay for Web3Telegram
1010

11-
[Web3Telegram](/references/web3telegram) dev tool offers secure, blockchain-based
12-
communication by encrypting emails and protecting user privacy.
11+
[Web3Telegram](/references/web3telegram) dev tool offers secure,
12+
blockchain-based communication by encrypting emails and protecting user privacy.
1313

1414
The `sendTelegram` function uses confidential computing power to encrypt and
1515
send messages, ensuring secure and decentralized email exchanges.

src/references/iapp-generator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ minutes, not months.
4141

4242
Start here to understand what iApps are and how they work:
4343

44-
- **[What Is an iApp?](/get-started/overview/what-is-iapp)** - Core
45-
concepts and TEE overview
44+
- **[What Is an iApp?](/get-started/overview/what-is-iapp)** - Core concepts and
45+
TEE overview
4646
- **[Getting Started](/references/iapp-generator/getting-started)** - Your first
4747
iApp in 15 minutes
4848
- **[Building Your iApp](/references/iapp-generator/building-your-iexec-app)** -

0 commit comments

Comments
 (0)