Skip to content

Update docs #14

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

Merged
merged 3 commits into from
Jul 16, 2025
Merged

Update docs #14

merged 3 commits into from
Jul 16, 2025

Conversation

patricijabrecko
Copy link
Contributor

Summary

This pull request includes updates to the documentation for the Airdrop SDK, function invocation, and metadata extraction.

Work item

https://app.devrev.ai/devrev/works/ISS-190744

@Copilot Copilot AI review requested due to automatic review settings July 16, 2025 11:26
Copy link
Contributor

@Copilot 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 updates the documentation for metadata extraction stage diagrams, streamlines the function invocation guide, and refines the Airdrop SDK secrets section.

  • Adds a new metadata-extraction guide illustrating how to configure state transitions in external record types.
  • Revises the function invocation documentation to use a simplified AirdropEvent signature and runner flow.
  • Clarifies required _secrets_ properties in the Airdrop SDK library documentation.

Reviewed Changes

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

File Description
docs/metadata-extraction.mdx New section for configuring state transition diagrams
docs/function_invocation.mdx Updated invocation flow and run method signature
docs/airdrop_sdk_library_documentation.md Refined list of required secret properties
Comments suppressed due to low confidence (3)

docs/function_invocation.mdx:3

  • [nitpick] Consider linking to or briefly describing the structure of AirdropEvent so readers know which fields are included and which can be ignored.
Runner.ts processes events of type "any", which are basically events of type "AirdropEvent" with some additional fields, and passes the events to the function. You can ignore the additional fields.

docs/airdrop_sdk_library_documentation.md:366

  • Indent secret properties two spaces under the - _secrets_ list item so they render as a nested sublist in Markdown.
    - _service_account_token_: Required. A **string** representing the DevRev authentication token for Airdrop platform

docs/function_invocation.mdx:7

  • TypeScript array syntax should be AirdropEvent[] instead of []AirdropEvent to correctly declare an array of events.
async function run(events: []AirdropEvent): void;

@patricijabrecko patricijabrecko merged commit 19f87c5 into main Jul 16, 2025
2 checks passed
@patricijabrecko patricijabrecko deleted the updates branch July 16, 2025 11:53
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.

2 participants