refactor: Rework the 'Introduction' & 'Getting Started' page #89
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
…te corresponding guide
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ides for clarity and consistency
…tector across multiple guides
…pdate links in multiple guides
Le-Caignec
requested review from
64ix,
aimen-djari and
Copilot
and removed request for
aimen-djari
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the documentation structure by removing redundant "Introduction" and "Getting Started" pages from the "Use iApp" section, consolidating their content into more focused guides. The core deal execution flow content has been moved to a dedicated overview page, while installation instructions are now embedded directly in relevant guides with references to the official SDK documentation.
Key changes:
- Removed
/guides/use-iapp/introduction.mdand/guides/use-iapp/getting-started.mdfiles - Created new
/get-started/overview/deal.mdpage for deal execution flow documentation - Updated installation sections across multiple guides to reference SDK documentation consistently
Reviewed Changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/references/sdk.md |
Changed installation examples from DataProtector package to iExec SDK package and added reference link to full SDK documentation |
src/index.md |
Updated "Use iApp" feature link to point directly to the run-iapp-with-ProtectedData guide |
src/guides/use-iapp/run-iapp-without-ProtectedData.md |
Enhanced prerequisites section with SDK installation instructions and reference link |
src/guides/use-iapp/run-iapp-with-ProtectedData.md |
Added prerequisites section with DataProtector installation instructions |
src/guides/use-iapp/introduction.md |
Deleted entire file containing network actors and deal flow documentation |
src/guides/use-iapp/getting-started.md |
Deleted entire file containing getting started guide |
src/guides/manage-data/manage-access.md |
Renamed "Installation" section to "Prerequisites" and added reference to DataProtector documentation |
src/guides/build-iapp/outputs.md |
Removed broken reference to deleted getting-started page |
src/guides/build-iapp/manage-access.md |
Updated SDK documentation references from GitHub to internal documentation pages |
src/guides/build-iapp/inputs.md |
Updated internal link from deleted introduction page to specific run-iapp guide |
src/guides/build-iapp/build-&-test.md |
Expanded prerequisites section with installation code blocks and reference link |
src/guides/build-iapp/advanced/result-callback.md |
Updated SDK installation reference from deleted getting-started page to SDK documentation |
src/guides/build-iapp/advanced/quick-start.md |
Added reference to SDK documentation for installation instructions |
src/get-started/overview/deal.md |
New file documenting deal coordination mechanism and execution flow |
.vitepress/sidebar.ts |
Removed sidebar entries for deleted introduction and getting-started pages, added entry for new deal overview page |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… guide; update related documentation for clarity
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 15 out of 17 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Le-Caignec
deleted the
feat/rework-introduction-&-getting-started-page
branch
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.
No description provided.