Skip to content

Conversation

@snigdha920
Copy link
Contributor

@snigdha920 snigdha920 commented Jan 8, 2025

Updates:

Summary by Sourcery

Update documentation for smart contract sets, access tokens, and platform components.

Documentation:

  • Clarify the process of adding a smart contract set, including template selection and deployment plan details.
  • Update the documentation for Fabric middleware to include information about access tokens and replace example URLs and tokens.
  • Add information about application access tokens and their usage in connecting frontends and integrations.
  • Update the documentation for private keys to clarify their usage with signing proxies.
  • Update the documentation for Insights, clarifying the supported node types.
  • Update the "Components" section to include Insights and update the middleware options.
  • Correct broken links and outdated information in various documentation sections, including deployment plans, creating accounts, managing organizations, and adding resources like nodes, networks, and storage.
  • Improve the clarity and accuracy of the documentation for connecting frontends, asset tokenization, and resource usage.

Summary by Sourcery

Documentation:

  • Updated documentation for smart contracts, access tokens, and platform components, including correcting broken links and outdated information.

@linear
Copy link

linear bot commented Jan 8, 2025

ENG-2136 Update documentation in guides

  • Replace all mentions of “Smart Contract Sets” with “Dev Tools” in the documentation
  • Ensure consistency across all user guides, tutorials, and help sections
  • Update the quick start guides to reflect the new form steps and options.
  • Include instructions on using the new SDK CLI.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 8, 2025

Reviewer's Guide by Sourcery

This PR updates the documentation to reflect the new Smart Contract Sets feature. Several pages were updated to redirect to the Smart Contract Sets documentation, and outdated references to the Smart Contract IDE were removed.

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

File-Level Changes

Change Details Files
Updated blockchain guides to reference Smart Contract Sets.
  • Removed outdated Smart Contract IDE sections.
  • Added new Smart Contract Sets sections.
  • Updated links to point to new Smart Contract Sets documentation.
docs/blockchain-guides/0_Ethereum/5_ethereum-integration-tools.md
docs/blockchain-guides/10_Polygon-zkEVM/5_polygon-zkevm-integration-tools.md
docs/blockchain-guides/11_Fantom/5_fantom-integration-tools.md
docs/blockchain-guides/12_Soneium/5_soneium-integration-tools.md
docs/blockchain-guides/1_Hyperledger-Besu/6_enterprise-ethereum-integration-tools.md
docs/blockchain-guides/2_Avalanche/5_avalanche-integration-tools.md
docs/blockchain-guides/4_Polygon/5_polygon-integration-tools.md
docs/blockchain-guides/7_Arbitrum/5_arbitrum-integration-tools.md
docs/blockchain-guides/8_Optimism/5_optimism-integration-tools.md
docs/blockchain-guides/9_Hedera/5_hedera-integration-tools.md
docs/blockchain-guides/5_Hyperledger-Fabric/6_hyperledger-fabric-integration-tools.md
Updated Middleware documentation to include information about access tokens and smart contract sets.
  • Added information about Application Access Tokens.
  • Replaced example URLs and tokens.
  • Updated references to smart contract sets.
docs/using-platform/7_middleware.md
Updated Smart Contract Sets documentation to include a template library.
  • Added a template library section with links to available templates.
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/2_smart-contract-templates.md
Updated Asset Tokenization documentation to reflect changes related to smart contract sets.
  • Updated smart contract creation section to reflect smart contract sets.
  • Updated API key section to reflect access tokens.
docs/developer-guides/asset-tokenization.md
Updated Connect Frontend documentation to reflect changes related to smart contract sets and access tokens.
  • Updated smart contract deployment section to reflect smart contract sets.
  • Updated API key section to reflect access tokens.
docs/developer-guides/connect-frontend.md
Updated Smart Contract Sets documentation to reflect the new structure and usage.
  • Updated overview of smart contract deployment process.
  • Updated instructions for adding a smart contract set.
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/3_add-smart-contract-set.md
Updated Create an Account documentation to remove outdated information and clarify the signup process.
  • Removed information about the €250 free credit.
  • Clarified the signup process with magic links.
  • Updated organization and application information.
docs/launch-platform/managed-cloud-deployment/2_create-an-account.md
Updated Components documentation to include Insights and update middleware options.
  • Added Insights to the list of components.
  • Updated middleware options to include Firefly Fabconnect.
docs/about-settlemint/4_components.mdx
Updated Attestation Service documentation to reflect changes related to smart contract sets.
  • Updated instructions for adding the smart contract set.
docs/developer-guides/attestation-service.md
Updated Add a Node to a Network documentation to clarify the node deployment process.
  • Clarified the node deployment process and resource allocation.
docs/using-platform/4_add-a-node-to-a-network.md
Updated Deployment Plans documentation to simplify the title and description.
  • Simplified the title and description.
docs/launch-platform/managed-cloud-deployment/13_deployment-plans.md
Updated Private Keys documentation to remove outdated information about the signing proxy.
  • Removed outdated information about the signing proxy and smart contract set IDE.
docs/using-platform/12_private-keys.md
Updated Add a Network to an Application documentation to clarify the application context.
  • Clarified the application context for organizing resources.
docs/using-platform/1_add-a-network-to-an-application.md
Updated Code Studio documentation to clarify the purpose and types of code studios.
  • Clarified the purpose and types of code studios.
docs/using-platform/15_dev-tools/0_code-studio/0_code-studio.md
Updated Personal Access Tokens documentation to improve clarity and cross-referencing.
  • Improved clarity and cross-referencing with Application Access Tokens.
docs/using-platform/17_personal-access-tokens.md
Updated Resource Usage documentation to clarify resource allocation and deployment plans.
  • Clarified resource allocation and deployment plans.
docs/using-platform/19_resource-usage.md
Updated Join a Network by Invitation documentation to correct the link to Create an Account.
  • Corrected the link to Create an Account.
docs/using-platform/3_join-a-network-by-invitation.md
Updated Integration Studio documentation to clarify the deployment process.
  • Clarified the deployment process and resource allocation.
docs/using-platform/8_integration-studio.md
Updated Hasura Backend as a Service documentation to clarify the deployment process.
  • Clarified the deployment process and resource allocation.
docs/using-platform/9_hasura-backend-as-a-service.md
Updated Insights documentation to clarify supported node types.
  • Clarified supported node types.
docs/using-platform/10_insights.md
Updated Storage documentation to clarify the deployment process.
  • Clarified the deployment process and resource allocation.
docs/using-platform/11_storage.md
Updated homepage link to documentation.
  • Updated homepage link to documentation.
src/pages/index.tsx
Updated Quickstart documentation to simplify the title and remove sidebar positioning.
  • Simplified the title and removed sidebar positioning.
docs/launch-platform/managed-cloud-deployment/1_quickstart.md
Updated Deploying a Smart Contract documentation to simplify the title and remove sidebar positioning.
  • Simplified the title and removed sidebar positioning.
docs/using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/4_deploying-a-contract.md
Added GraphQL dependency.
  • Added graphql-request dependency
package.json
Updated prettier config.
  • Updated prettier config.
.prettierrc
Updated bun lock file.
  • Updated bun lock file.
bun.lockb
Updated category config.
  • Updated category config.
docs/launch-platform/managed-cloud-deployment/_category_.json
Added smart-contract-templates.ts file.
  • Added smart-contract-templates.ts file for generating markdown templates.
smart-contract-templates.ts

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 9, 2025 12:00
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: 2 issues 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.

@snigdha920 snigdha920 requested a review from SilVdB January 9, 2025 12:23
@snigdha920 snigdha920 merged commit 3f6c9cc into main Jan 9, 2025
2 checks passed
@snigdha920 snigdha920 deleted the snigdha/eng-2136-update-documentation-in-guides branch January 9, 2025 16:41
snigdha920 added a commit that referenced this pull request Jan 10, 2025
…-section

* main:
  chore(deps): update dependency docusaurus-lunr-search to v3.6.0 (#126)
  feat: update smart contract set documentation  (#123)
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