feat: simplify doc as debug mode disappear #42
Merged
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
- Updated links in debugging and inputs/outputs guides to reflect new result decryption guide. - Added new guide on downloading and decrypting iApp results, detailing the process and providing code examples. - Removed outdated debug mode option from access management guide. - Streamlined input handling sections in execution guides, consolidating command-line argument examples. - Enhanced getting started guide with clearer prerequisites and installation instructions. - Removed unnecessary debug-related code snippets from the DataProtector documentation. - Updated iApp generator documentation to clarify project modes and removed debug mode references. - Improved formatting and clarity in the getting started guide for the iApp generator.
…payment execution guide - Deleted sections on using CLI with RLC and vouchers, as well as the batch operations example to streamline the documentation. - Focused on enhancing clarity and relevance of payment methods in the guide.
- Renamed and reorganized sections in the sidebar for clarity, replacing 'Different Ways to Execute an iApp' with 'Run iApp' and 'Use iApp with Protected Data' with 'Run iApp with Inputs'. - Updated links in the 'Getting Started' guide to reflect the new structure. - Added new guides for 'Run an iApp' and 'Run iApp with Inputs', detailing execution methods and input handling. - Removed the outdated 'Use iApp with Protected Data' guide to streamline documentation.
- Enhanced readability by breaking long lines into multiple lines in the 'Choosing Between Toolkit' section. - Maintained the content integrity while improving the overall presentation of the guide.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…xamples - Added a new section outlining when to use each execution method: iApp Generator CLI, iExec Library, and iExec CLI. - Introduced detailed code examples for using the iExec SDK Library and iExec CLI for executing iApps. - Improved overall organization and clarity of the guide to assist users in selecting the appropriate execution method.
- Renamed 'Build and Deploy' to 'Build and Test' in navigation and sidebar for consistency. - Added a new guide for 'Build and Test an iApp' detailing the creation and testing process. - Introduced a new guide for 'Deploy and Run an iApp' covering deployment methods and execution on the iExec network. - Updated links in existing documentation to align with the new guide structure.
…ucture - Removed outdated deployment examples from the 'Build and Test' guide to streamline content. - Enhanced the 'Deploy and Run' guide with a clearer introduction and restructured sections for better flow. - Updated headings for consistency and improved readability throughout the documentation.
… details - Added sections explaining the creation of `deployments.json` and `runs.json` files for tracking deployments and runs on the iExec network. - Included JSON examples to illustrate the structure of the tracking files. - Updated next steps to guide users on managing access and debugging techniques.
- Enhanced the 'Build and Test an iApp' and 'Deploy and Run an iApp' guides by breaking long lines in descriptions for better readability. - Removed the outdated 'Run an iApp' and 'Run iApp with Inputs' guides to streamline documentation. - Updated descriptions and sections to improve clarity and consistency across the guides.
Le-Caignec
changed the title
- Moved the 'Run iApp without ProtectedData' link to follow the 'Run iApp with ProtectedData' link for better logical flow in the sidebar. - Ensured consistent presentation of guide links to enhance user experience.
- Updated the 'Run iApp with ProtectedData' guide to emphasize the role of ProtectedData as a powerful input type while introducing non-persistent inputs for customization. - Revised the 'Run iApp without ProtectedData' guide to highlight the flexibility of using non-persistent inputs, including Arguments, Input Files, and Secrets, for tailored iApp executions.
…uide - Included a new section outlining the prerequisites for using the iApp, specifically the installation of the iExec SDK. - Provided installation commands for various package managers (npm, yarn, pnpm, bun) to facilitate user setup.
- Eliminated the 'Next Steps' sections from both 'Run iApp with ProtectedData' and 'Run iApp without ProtectedData' guides to streamline content and focus on core instructions.
- Eliminated the 'Output Retrieval' section to streamline the guide and focus on essential content, enhancing user experience.
- Replaced the placeholder character with the correct emoji for the 'Glossary' link in the sidebar, enhancing visual clarity.
- Improved the guide in the build-iapp section to provide clearer instructions on processing protectedData and clarifying input-output relationships. - Refactored the iApp generator CLI reference for better organization and usability.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.