creating-integration-docs

Generate documentation scaffolds for new Nango integrations with config updates.

11.4k|1.2k|Updated Apr 9, 2020
One-click install
npx skills add https://github.com/NangoHQ/nango --skill creating-integration-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: creating-integration-docs
Source: https://github.com/NangoHQ/nango/tree/main/.claude/skills/creating-integration-docs
Command: npx skills add https://github.com/NangoHQ/nango --skill creating-integration-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines creating documentation for a new Nango integration by automatically generating the main page, a setup guide, and the necessary config updates to docs.json and providers.yaml following established patterns.

Core Features & Use Cases

  • Documentation scaffolding: Generates the main integration page at docs/api-integrations/[slug].mdx.
  • Setup guide generation: Creates the step-by-step setup guide for OAuth apps and integration onboarding.
  • Config updates: Updates docs.json and providers.yaml to reflect the new integration and ensure navigation and docs links are accurate.

Quick Start

Run this skill to scaffold the integration documentation structure for a new Nango integration. The tool will generate the main page, the setup guide, and update docs.json and providers.yaml according to the established patterns.

Frequently Asked Questions about creating-integration-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation scaffolding for a new Nango integration?

To generate Nango integration documentation, run this skill to create the main page at docs/api-integrations/[slug].mdx, a setup guide, and update docs.json and providers.yaml automatically.

What files are updated when creating integration docs scaffolding?

Creating integration docs scaffolding updates docs.json and providers.yaml to reflect the new integration, ensuring navigation links and provider configurations are accurate and follow established patterns.

How does integration documentation scaffolding handle slug naming and frontmatter?

Integration documentation scaffolding enforces slug-lowercase naming and applies proper frontmatter fields to ensure the generated mdx files follow correct file structure patterns for seamless documentation generation.

Can I use this scaffolding to onboard a brand-new integration into Nango?

Yes, you can use this scaffolding to onboard a brand-new Nango integration by generating the main docs page, a step-by-step OAuth setup guide, and the necessary configuration updates in one run.

Does the integration docs setup guide include OAuth app onboarding steps?

Yes, the integration docs setup guide includes step-by-step instructions for OAuth app configuration and integration onboarding, ensuring users can properly set up the new Nango provider.

Why do my Nango integration docs fail to generate correctly without providers.yaml updates?

Nango integration docs require providers.yaml updates to register the new provider configuration; without this update, the generated documentation pages lack accurate links and integration metadata.