-
Notifications
You must be signed in to change notification settings - Fork 0
feat: generative ai plugin docs #128
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.
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
Conversation
Reviewer's Guide by SourceryThis pull request introduces documentation for the new Generative AI plugin in the SettleMint platform. It explains the plugin's features, benefits, and usage with examples and a video tutorial. The documentation also clarifies how to deploy smart contracts using the platform's IDE, including compiling and deploying to local and platform networks. Sequence diagram for deploying a smart contract to platform networksequenceDiagram
actor Developer
participant IDE
participant TaskManager
participant Platform
participant Network
Developer->>IDE: Open IDE
Developer->>TaskManager: Run 'SettleMint - Login'
TaskManager->>Platform: Authenticate
Developer->>TaskManager: Run 'Hardhat - Build'
TaskManager->>IDE: Compile contracts
Developer->>TaskManager: Run 'Deploy to platform network'
TaskManager->>Developer: Request node selection
Developer->>TaskManager: Select node
TaskManager->>Developer: Request private key
Developer->>TaskManager: Select private key
TaskManager->>Network: Deploy contract
Network-->>Developer: Confirm deployment
Sequence diagram for deploying a smart contract to local networksequenceDiagram
actor Developer
participant IDE
participant TaskManager
participant LocalNetwork
Developer->>IDE: Open IDE
Developer->>TaskManager: Run 'Hardhat - Build'
TaskManager->>IDE: Compile contracts
Developer->>TaskManager: Run 'Start local network'
TaskManager->>LocalNetwork: Initialize network
Developer->>TaskManager: Run 'Deploy to local network'
TaskManager->>LocalNetwork: Deploy contract
LocalNetwork-->>Developer: Confirm deployment
Flow diagram for smart contract deployment processflowchart TD
A[Start] --> B[Open IDE]
B --> C[Access Task Manager]
C --> D{Choose Framework}
D -->|Hardhat| E[Run Hardhat Build]
D -->|Foundry| F[Run Foundry Build]
E --> G{Choose Network}
F --> G
G -->|Platform Network| H[Login to Platform]
H --> I[Select Node]
I --> J[Select Private Key]
J --> K[Deploy Contract]
G -->|Local Network| L[Start Local Network]
L --> M[Deploy to Local Network]
M --> N[End]
K --> N
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @snigdha920 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider retaining terminal-based deployment instructions in a collapsed section for users who prefer command-line interfaces.
- The AI plugin documentation would benefit from more detailed examples of practical use cases and limitations of the tool beyond the basic prompts.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/4_deploying-a-contract.md
Outdated
Show resolved
Hide resolved
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
* main: feat: update deploying a contract section (#127)
Branches off #127, moves https://github.com/settlemint/docs/pull/123/files#diff-cd9af8f677658ff9c6841ebfb7674e32be902ea86f0f2e200cddddf9ea053881L36-L52 to it's own page
Summary by Sourcery
New Features: