Skip to content

Conversation

@snigdha920
Copy link
Contributor

@snigdha920 snigdha920 commented Jan 8, 2025

  • Adds documentation for Dev tools, Code studio
  • Adds changelog for Dev tools release
  • Reorders the items in the 'Building with SettleMint' section to match the sidebar in the platform
  • Adds a prettierrc config

Changelog:

CleanShot 2025-01-08 at 11 52 18@2x

Dev tools docs:

CleanShot 2025-01-08 at 12 42 52@2x

Summary by Sourcery

Introduce Code Studio, a web-based IDE for building dApps. It includes pre-configured extensions, GitHub integration, and a SettleMint SDK CLI for easy platform interaction. Update Smart Contract Sets to be launched within Code Studio, offering a choice of pre-built templates.

New Features:

  • Introduce Code Studio, a web-based IDE with pre-configured extensions, GitHub integration, and SettleMint SDK CLI.

Documentation:

  • Move smart contract set documentation under dev tools section.
  • Update smart contract set documentation to reflect Code Studio integration.
  • Update documentation to replace "smart contract sets" with "dev tools".

Summary by Sourcery

New Features:

  • Introduce Code Studio, a web-based IDE with pre-configured extensions, GitHub integration, and SettleMint SDK CLI.

@linear
Copy link

linear bot commented Jan 8, 2025

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 8, 2025

Reviewer's Guide by Sourcery

This pull request introduces documentation for developer tools, specifically Code Studio, and implements several improvements to the existing documentation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for Code Studio and dev tools.
  • Created new documentation files for Code Studio and dev tools in the using-platform section.
  • Added a changelog entry for the dev tools release.
  • Included screenshots and explanations of the new features in the documentation.
docs/using-platform/15_dev-tools/0_code-studio/0_code-studio.md
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/1_smart-contract-sets.md
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/2_smart-contract-templates.md
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/3_add-smart-contract-set.md
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/4_deploying-a-contract.md
docs/using-platform/15_dev-tools/15_dev-tools.md
docs/using-platform/15_dev-tools/_category_.json
releases/2025-01-08-dev-tools.md
Reorganized smart contract set documentation.
  • Moved smart contract set documentation under the dev tools section.
  • Updated the smart contract set documentation to reflect Code Studio integration.
  • Updated documentation to replace "smart contract sets" with "dev tools".
docs/using-platform/6_add_smart_contract_sets/0_smart_contracts.md
docs/using-platform/6_add_smart_contract_sets/1_smart_contract_templates.md
docs/using-platform/6_add_smart_contract_sets/2_create_smart_contract_set.md
docs/using-platform/6_add_smart_contract_sets/3_deploying_a_contract.md
docs/using-platform/6_add_smart_contract_sets/_category_.json
docs/about-settlemint/4_components.mdx
Updated documentation links and references.
  • Updated links referencing smart contract sets to point to the new dev tools section.
  • Corrected outdated links and references across various documentation files.
  • Ensured consistency in terminology and document structure.
docs/blockchain-guides/0_Ethereum/5_ethereum-integration-tools.md
docs/blockchain-guides/0_Ethereum/Template-library/1_ethereum-erc-20.md
docs/blockchain-guides/0_Ethereum/Template-library/2_ethereum-erc-721.md
docs/blockchain-guides/1_Hyperledger-Besu/6_enterprise-ethereum-integration-tools.md
docs/blockchain-guides/1_Hyperledger-Besu/9_enterprise-ethereum-connect-external-network.md
docs/blockchain-guides/1_Hyperledger-Besu/Template-library/1_enterprise-ethereum-erc20.md
docs/blockchain-guides/1_Hyperledger-Besu/Template-library/2_enterprise-ethereum-erc721.md
docs/blockchain-guides/10_Polygon-zkEVM/5_polygon-zkevm-integration-tools.md
docs/blockchain-guides/10_Polygon-zkEVM/Template-library/1_polygon-zkevm-erc-20.md
docs/blockchain-guides/10_Polygon-zkEVM/Template-library/2_polygon-zkevm-erc-721.md
docs/blockchain-guides/11_Fantom/5_fantom-integration-tools.md
docs/blockchain-guides/11_Fantom/Template-library/1_fantom-erc-20.md
docs/blockchain-guides/11_Fantom/Template-library/2_fantom-erc-721.md
docs/blockchain-guides/12_Soneium/5_soneium-integration-tools.md
docs/blockchain-guides/12_Soneium/Template-library/1_soneium-erc-20.md
docs/blockchain-guides/12_Soneium/Template-library/2_soneium-erc-721.md
docs/blockchain-guides/2_Avalanche/5_avalanche-integration-tools.md
docs/blockchain-guides/2_Avalanche/Template-library/1_avalanche-erc-20.md
docs/blockchain-guides/2_Avalanche/Template-library/2_avalanche-erc-721.md
docs/blockchain-guides/4_Polygon/5_polygon-integration-tools.md
docs/blockchain-guides/4_Polygon/Template-library/1_polygon-erc-20.md
docs/blockchain-guides/4_Polygon/Template-library/2_polygon-erc-721.md
docs/blockchain-guides/7_Arbitrum/5_arbitrum-integration-tools.md
docs/blockchain-guides/7_Arbitrum/Template-library/1_arbitrum-erc-20.md
docs/blockchain-guides/7_Arbitrum/Template-library/2_arbitrum-erc-721.md
docs/blockchain-guides/8_Optimism/5_optimism-integration-tools.md
docs/blockchain-guides/8_Optimism/Template-library/1_optimism-erc-20.md
docs/blockchain-guides/8_Optimism/Template-library/2_optimism-erc-721.md
docs/blockchain-guides/9_Hedera/5_hedera-integration-tools.md
docs/blockchain-guides/9_Hedera/Template-library/1_hedera-erc-20.md
docs/blockchain-guides/9_Hedera/Template-library/2_hedera-erc-721.md
docs/launch-platform/managed-cloud-deployment/1_quickstart.md
docs/reference/14_statuses.md
docs/using-platform/1_add-a-network-to-an-application.md
docs/using-platform/2_add-a-node-to-a-network.md
docs/using-platform/3_add-a-load-balancer.md
docs/using-platform/3_join-a-network-by-invitation.md
docs/using-platform/4_join-a-network-by-invitation.md
docs/using-platform/7_integrated-development-environment.md
docs/using-platform/7_middleware.md
docs/using-platform/8_integration-studio.md
docs/using-platform/9_hasura-backend-as-a-service.md
docs/using-platform/9_integration-studio.md
Added a prettierrc config file.
  • Introduced a prettierrc configuration file to enforce consistent code formatting.
.prettierrc
Minor style and formatting adjustments.
  • Made minor updates to the CSS file to improve styling and visual presentation.
src/css/custom.css

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the feat New feature label Jan 8, 2025
@snigdha920 snigdha920 marked this pull request as ready for review January 8, 2025 11:40
Copy link

@sourcery-ai sourcery-ai bot left a 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 and they look great!

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.

Comment on lines 70 to +73
Blockchain applications produce data that lives on the blockchain, but we need to
be able to access that data in order to use it. Creating a [middleware](../../using-platform/middleware/)
allows us SettleMint currently offers two middleware services: The Graph and Smart
Contract Portal Middleware.{' '}
Contract Portal Middleware.{" "}
Copy link

Choose a reason for hiding this comment

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

issue (typo): This sentence appears to be grammatically incorrect or incomplete

Consider revising the sentence structure to clearly explain what SettleMint allows users to do with middleware services.

Suggested change
Blockchain applications produce data that lives on the blockchain, but we need to
be able to access that data in order to use it. Creating a [middleware](../../using-platform/middleware/)
allows us SettleMint currently offers two middleware services: The Graph and Smart
Contract Portal Middleware.{' '}
Contract Portal Middleware.{" "}
Blockchain applications produce data that lives on the blockchain, but we need to
be able to access that data in order to use it. [Middleware](../../using-platform/middleware/)
allows us to efficiently interact with and query blockchain data. SettleMint currently offers
two middleware services: The Graph and Smart Contract Portal Middleware.{" "}

@roderik roderik merged commit 694bed9 into main Jan 8, 2025
2 checks passed
@roderik roderik deleted the snigdha/eng-1829-update-documentation-everywhere branch January 8, 2025 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat New feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants