Skip to content

docs: align getting-started pages format with iApp Generator #90

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

Open
SeddikBellamine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: align getting-started pages format with iApp Generator #90

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
40 changes: 27 additions & 13 deletions src/references/dataProtector/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,36 @@
and access controls in minutes.
---

# Getting Started
# 🛡 Getting Started

[![GitHub package.json version (branch)](https://img.shields.io/badge/npm-2.0.0--beta-green)](https://www.npmjs.com/package/@iexec/dataprotector)

## Overview

### Prerequisites

Before getting started, ensure that you have the following installed on your
system:

\- [**Node.js**](https://nodejs.org/en/) version 18 or higher

\- [**NPM**](https://docs.npmjs.com/) (Node.js package manager)

### Installation
## 🕕 Prerequisites

Before using DataProtector, make sure you have:

<div class="flex flex-col gap-2 my-4 pl-0">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 Node.js v18+ (required)

Check notice on line 20 in src/references/dataProtector/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/dataProtector/getting-started.md#L20 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/dataProtector/getting-started.md", "range": {"start": {"line": 20, "column": 22}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://nodejs.org/en/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)

Check failure on line 26 in src/references/dataProtector/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/dataProtector/getting-started.md#L26 

[Vale.Terms] Use 'npm' instead of 'NPM'.
Raw output 
{"message": "[Vale.Terms] Use 'npm' instead of 'NPM'.", "location": {"path": "src/references/dataProtector/getting-started.md", "range": {"start": {"line": 26, "column": 9}}}, "severity": "ERROR"}

Check notice on line 26 in src/references/dataProtector/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/dataProtector/getting-started.md#L26 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/dataProtector/getting-started.md", "range": {"start": {"line": 26, "column": 13}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
Comment on lines +24 to +30
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 24 has 3 spaces while line 18 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
Comment on lines +24 to +30
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 30 has 3 spaces while line 18 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
💰 RLC Tokens (for data protection)

Check notice on line 32 in src/references/dataProtector/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/dataProtector/getting-started.md#L32 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/dataProtector/getting-started.md", "range": {"start": {"line": 32, "column": 20}}}, "severity": "INFO"}
</div>
<a href="/get-started/overview/rlc" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
</div>

### 📦 Installation

::: code-group

Expand Down
40 changes: 27 additions & 13 deletions src/references/web3mail/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,36 @@
email communication.
---

# Getting Started
# 📧 Getting Started

[![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/iExecBlockchainComputing/web3mail-sdk?color=green)](https://github.com/iExecBlockchainComputing/web3mail-sdk)

## Overview

### Prerequisites

Before getting started, ensure that you have the following installed on your
system:

\- [**Node.js**](https://nodejs.org/en/) version 18 or higher

\- [**NPM**](https://docs.npmjs.com/) (Node.js package manager)

### Installation
## 🕕 Prerequisites

Before using Web3Mail, make sure you have:

<div class="flex flex-col gap-2 my-4 pl-0">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 Node.js v18+ (required)

Check notice on line 20 in src/references/web3mail/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3mail/getting-started.md#L20 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3mail/getting-started.md", "range": {"start": {"line": 20, "column": 22}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://nodejs.org/en/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)

Check failure on line 26 in src/references/web3mail/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3mail/getting-started.md#L26 

[Vale.Terms] Use 'npm' instead of 'NPM'.
Raw output 
{"message": "[Vale.Terms] Use 'npm' instead of 'NPM'.", "location": {"path": "src/references/web3mail/getting-started.md", "range": {"start": {"line": 26, "column": 9}}}, "severity": "ERROR"}

Check notice on line 26 in src/references/web3mail/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3mail/getting-started.md#L26 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3mail/getting-started.md", "range": {"start": {"line": 26, "column": 13}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
Comment on lines +24 to +30
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 24 has 3 spaces while line 18 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
Comment on lines +24 to +30
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 30 has 3 spaces while line 18 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
💰 RLC Tokens (for email operations)

Check notice on line 32 in src/references/web3mail/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3mail/getting-started.md#L32 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3mail/getting-started.md", "range": {"start": {"line": 32, "column": 20}}}, "severity": "INFO"}
Copy link
Collaborator

@Le-Caignec Le-Caignec Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
💰 RLC Tokens (for email operations)
💰 RLC Tokens (to send email)

</div>
<a href="/get-started/overview/rlc" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
</div>

### 📦 Installation

::: code-group

Expand Down
40 changes: 27 additions & 13 deletions src/references/web3telegram/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,36 @@
Telegram messages. Install the SDK and integrate it with your Web3 project.
---

# Getting started
# 📱 Getting Started

[![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/iExecBlockchainComputing/web3telegram-sdk?color=green)](https://github.com/iExecBlockchainComputing/web3telegram-sdk)

## Overview

### Prerequisites

Before getting started, ensure that you have the following installed on your
system:

\- [**Node.js**](https://nodejs.org/en/) version 18 or higher

\- [**NPM**](https://docs.npmjs.com/) (Node.js package manager)

### Installation
## 🕕 Prerequisites

Before using Web3Telegram, make sure you have:

<div class="flex flex-col gap-2 my-4 pl-0">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 Node.js v18+ (required)

Check notice on line 19 in src/references/web3telegram/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3telegram/getting-started.md#L19 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3telegram/getting-started.md", "range": {"start": {"line": 19, "column": 22}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://nodejs.org/en/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)

Check failure on line 25 in src/references/web3telegram/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3telegram/getting-started.md#L25 

[Vale.Terms] Use 'npm' instead of 'NPM'.
Raw output 
{"message": "[Vale.Terms] Use 'npm' instead of 'NPM'.", "location": {"path": "src/references/web3telegram/getting-started.md", "range": {"start": {"line": 25, "column": 9}}}, "severity": "ERROR"}

Check notice on line 25 in src/references/web3telegram/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3telegram/getting-started.md#L25 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3telegram/getting-started.md", "range": {"start": {"line": 25, "column": 13}}}, "severity": "INFO"}
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
Comment on lines +23 to +29
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 23 has 3 spaces while line 17 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
Comment on lines +23 to +29
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation: line 29 has 3 spaces while line 17 has 2 spaces. This HTML structure should maintain consistent indentation throughout the div blocks.

Suggested change
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 NPM (Node.js package manager)
</div>
<a target="_blank" href="https://docs.npmjs.com/" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
<div class="flex items-center gap-4 text-left">

Copilot uses AI. Check for mistakes.
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
💰 RLC Tokens (for Telegram operations)

Check notice on line 31 in src/references/web3telegram/getting-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/web3telegram/getting-started.md#L31 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/web3telegram/getting-started.md", "range": {"start": {"line": 31, "column": 20}}}, "severity": "INFO"}
Copy link
Collaborator

@Le-Caignec Le-Caignec Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
💰 RLC Tokens (for Telegram operations)
💰 RLC Tokens (to send Telegram notifications)

</div>
<a href="/get-started/overview/rlc" class="no-underline! text-sm ml-auto hover:underline!">Learn More →</a>
</div>
</div>

### 📦 Installation

::: code-group

Expand Down