docs: align getting-started pages format with iApp Generator #90
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update DataProtector, Web3mail, and Web3telegram getting-started pages - Add modern flex layout with interactive download links for prerequisites - Include emojis and consistent visual hierarchy matching iApp Generator format
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR modernizes the "Getting Started" sections across three documentation files (Web3Telegram, Web3Mail, and DataProtector) by replacing plain text prerequisites with a visually enhanced, emoji-decorated layout using HTML/CSS components.
- Added emoji icons to section headings for better visual hierarchy
- Transformed plain markdown prerequisite lists into structured HTML divs with flexbox styling
- Included RLC Tokens as a new prerequisite with contextual descriptions for each product
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| src/references/web3telegram/getting-started.md | Updated prerequisites section with HTML-styled cards and added RLC tokens requirement for Telegram operations |
| src/references/web3mail/getting-started.md | Updated prerequisites section with HTML-styled cards and added RLC tokens requirement for email operations |
| src/references/dataProtector/getting-started.md | Updated prerequisites section with HTML-styled cards and added RLC tokens requirement for data protection |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+23
to
+29
| <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"> |
There was a problem hiding this comment.
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"> |
Comment on lines
+23
to
+29
| <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"> |
There was a problem hiding this comment.
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"> |
Comment on lines
+24
to
+30
| <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"> |
There was a problem hiding this comment.
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"> |
Comment on lines
+24
to
+30
| <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"> |
There was a problem hiding this comment.
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"> |
Comment on lines
+24
to
+30
| <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"> |
There was a problem hiding this comment.
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"> |
Comment on lines
+24
to
+30
| <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"> |
There was a problem hiding this comment.
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"> |
Le-Caignec
approved these changes
Nov 6, 2025
Collaborator
Le-Caignec
left a comment
Le-Caignec
left a comment
There was a problem hiding this comment.
So fix from me and Copilot
Please fix them before merging
| </div> | ||
| <div class="flex items-center gap-4 text-left"> | ||
| <div class="flex items-center gap-1 flex-1 text-sm font-medium"> | ||
| 💰 RLC Tokens (for email operations) |
Collaborator
There was a problem hiding this comment.
Suggested change
| 💰 RLC Tokens (for email operations) | |
| 💰 RLC Tokens (to send email) |
| </div> | ||
| <div class="flex items-center gap-4 text-left"> | ||
| <div class="flex items-center gap-1 flex-1 text-sm font-medium"> | ||
| 💰 RLC Tokens (for Telegram operations) |
Collaborator
There was a problem hiding this comment.
Suggested change
| 💰 RLC Tokens (for Telegram operations) | |
| 💰 RLC Tokens (to send Telegram notifications) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update DataProtector, Web3mail, and Web3telegram getting-started pages to match the modern format of iApp Generator.
Add interactive prerequisites section with styled download links and emojis for better user experience.
Ensure consistent visual hierarchy and improved readability across all reference documentation.