Skip to content

Updated snap-in template and documentation. #6

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

Closed
wants to merge 2 commits into from

Conversation

dusano
Copy link
Contributor

@dusano dusano commented Jun 30, 2025

Update to the snap-in template and some additional documentation. Here are the details of this update:

  1. In devrev-snapin-template.plain we've added a small implementation hint that AI consistently got wrong.

  2. In devrev-snapin-template.plain we've also added reference to function_invocation documentation. The file was copied from https://github.com/devrev/fern-api-docs/blob/main/fern/docs/pages/references/function_invocation.mdx

Please note the two changes that had to be done in this file:

  • service_account_id: string; was added to Context
  • keyrings was removed from InputData

as it seems that this file is not up-to-date with the latest version of the code.

  1. In docs/airdrop_sdk_library_documentation.md 'function_name' attribute was missing in AirdropEvent object. This was really confusing AI so I added it.

  2. We are also adding docs/mapping-reasons.mdx that is needed for initial domain mapping and will be referenced in specific snap-ins (e.g. Trello). The file was copied from https://github.com/devrev/fern-api-docs/blob/main/fern/docs/pages/airdrop/data-model/mapping-reasons.mdx

Work item: https://app.devrev.ai/devrev/works/ISS-188589

Using the exact names of docs files from Fern docs.
Copy link

@tilenkavcic tilenkavcic left a comment

Choose a reason for hiding this comment

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

Mapping reasons look good, they're a bit outdated on our part but it should work for 90% of IDM generation

@dusano dusano closed this Jul 2, 2025
@dusano dusano deleted the update-snap-in-template branch July 2, 2025 08:48
@dusano
Copy link
Contributor Author

dusano commented Jul 2, 2025

This pull request was closed since a new one (#8) was created for these changes.

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