Skip to content

Conversation

@patricijabrecko
Copy link
Contributor

@patricijabrecko patricijabrecko commented Aug 26, 2025

This pull request updates documentation and instructions related to the Snap-In and Airdrop SDK usage, with a focus on clarifying requirements for the SDK version, the initialDomainMapping parameter, and the handling of extraction state. The most important changes are summarized below:

SDK Version and Usage Requirements:

  • Updated the required Airdrop SDK Library version from "1.5.1" to "1.8.0" in the Snap-In template documentation, ensuring that all features and fixes up to the latest version are utilized.

initialDomainMapping Parameter Clarifications:

  • Changed the initialDomainMapping parameter from optional to required in the documentation for the spawn method, making it clear that this object must always be provided.
  • Clarified in the spawn method instructions that the initial domain mapping JSON object must be used for the initialDomainMapping parameter, and that it should be read directly from the JSON file.

Extraction Task Handling:

  • Removed the call to adapter.postState() in the onTimeout handler within the attachments extraction process documentation, likely to streamline or correct the timeout flow.

Issue: https://app.devrev.ai/devrev/works/ISS-206307

Copilot AI review requested due to automatic review settings August 26, 2025 12:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces minor updates to improve the robustness of code generation by refining documentation and template instructions. The changes focus on clarifying requirements and removing potentially problematic code patterns.

  • Updated spawn method instructions to better organize domain mapping requirements
  • Removed a potentially problematic postState() call from timeout handling documentation
  • Changed the initialDomainMapping parameter from optional to required in the SDK documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
templates/spawn_method_instructions.plain Reorganized bullet point structure for domain mapping requirements
docs/attachments-extraction.md Removed postState() call from timeout handler example
docs/airdrop_sdk_library_documentation.md Changed initialDomainMapping parameter from optional to required

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@patricijabrecko patricijabrecko merged commit 8a5cdd0 into main Sep 2, 2025
2 of 3 checks passed
@patricijabrecko patricijabrecko deleted the minor-updates branch September 2, 2025 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants