Skip to content

Conversation

@janb87
Copy link
Contributor

@janb87 janb87 commented Apr 29, 2025

Summary by Sourcery

Refactor documentation by introducing reusable snippets for middleware instructions, standardizing the term "Smart contract portal", and removing potentially destructive delete operations from code examples.

Documentation:

  • Create reusable snippets for creating and managing middleware.
  • Update documentation guides (EVM, Hedera) and component pages to use the new middleware snippets.
  • Standardize terminology by renaming "API Portal" to "Smart contract portal" throughout the documentation.
  • Remove potentially unsafe delete command examples for various platform components (networks, storage, smart contract sets, middleware).
  • Correct the SDK documentation link in the release notes.
  • Improve formatting with consistent line breaks and code block language identifiers.

@sourcery-ai
Copy link

sourcery-ai bot commented Apr 29, 2025

Reviewer's Guide by Sourcery

This pull request refactors the documentation for middleware setup and management by extracting common content into reusable snippets. It also renames "API Portal" to "Smart contract portal" across the documentation for consistency.

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

File-Level Changes

Change Details Files
Extracted common middleware setup and management instructions into reusable snippets.
  • Replaced detailed 'How to add middleware' and 'Manage middleware' sections with include directives.
  • Created new snippet files containing the extracted middleware instructions.
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-graph-middleware.mdx
content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-api-portal.mdx
content/docs/platform-components/middleware-and-api-layer/graph-middleware.mdx
content/docs/snippets/create-middleware.mdx
content/docs/snippets/manage-middleware.mdx
Renamed "API Portal" to "Smart contract portal" throughout the documentation.
  • Updated titles and descriptions.
  • Renamed headings and sections.
  • Replaced mentions of 'API portal' with 'Smart contract portal' in the text.
  • Updated links pointing to the portal documentation.
content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-api-portal.mdx
content/docs/platform-components/middleware-and-api-layer/smart-contract-api-portal.mdx
content/docs/index.mdx
content/docs/platform-components/middleware-and-api-layer/graph-middleware.mdx
content/docs/snippets/create-middleware.mdx
Applied various minor text and formatting updates.
  • Added line breaks (
    ) for better spacing.
  • Corrected code block language types (e.g., to bash or json).
  • Removed some SDK CLI/JS delete command examples from specific guide pages.
  • Updated the SDK documentation link in the SDK release notes.
content/docs/building-with-settlemint/evm-chains-guide/setup-graph-middleware.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-graph-middleware.mdx
content/docs/building-with-settlemint/evm-chains-guide/setup-api-portal.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-api-portal.mdx
content/docs/building-with-settlemint/evm-chains-guide/setup-code-studio.mdx
content/docs/building-with-settlemint/evm-chains-guide/setup-storage.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-storage.mdx
content/docs/building-with-settlemint/hyperledger-fabric-guide/setup-storage.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-code-studio.mdx
content/docs/building-with-settlemint/hedera-hashgraph-guide/add-network-and-nodes.mdx
content/docs/building-with-settlemint/evm-chains-guide/add-network-and-nodes.mdx
content/release-notes/settlemint-sdk.mdx
content/docs/platform-components/middleware-and-api-layer/graph-middleware.mdx
content/docs/platform-components/middleware-and-api-layer/smart-contract-api-portal.mdx
content/docs/index.mdx
content/docs/snippets/create-middleware.mdx
content/docs/snippets/manage-middleware.mdx

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

@janb87 janb87 changed the title fix: improve reuse for middleware docs fix: improve middleware docs and remove non existing sdk api's Apr 29, 2025
@github-actions github-actions bot added the fix Bug fix label Apr 29, 2025
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 @janb87 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Ensure the corresponding SDK methods for delete operations (networks, storage, smart contract sets) are removed or marked deprecated in the SDK codebase to match the documentation removal.
  • Double-check all documentation files for consistent use of 'Smart contract portal' instead of the older 'API Portal' term.
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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@janb87 janb87 enabled auto-merge (squash) April 29, 2025 10:00
@janb87 janb87 merged commit 643472f into main Apr 29, 2025
2 checks passed
@janb87 janb87 deleted the jan/improve-reuse branch April 29, 2025 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fix Bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants