Skip to content

Commit

Permalink
Improve introduction & restructure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bastienbeurier committed Oct 18, 2023
1 parent ac361d3 commit 3f1915d
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 87 deletions.
2 changes: 1 addition & 1 deletion docs-v2/guides/action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const result = await nango.triggerAction({

## Next Steps

Dive deeper with the [Customize Syncs & Actions guide](/guides/custom-script).
Dive deeper with the [Customize Syncs & Actions guide](/guides/custom).

## Questions, problems, feedback?

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: 'Customize Syncs & Actions'
sidebarTitle: 'Customize Syncs & Actions'
title: 'Build Your Own Integrations'
sidebarTitle: 'Build Your Own Integrations'
description: 'Extend & create your own custom syncs & actions.'
---

# Step 1: Setup the Nango CLI & nango-integrations folder

Install the Nango CLI globally:
Expand Down
7 changes: 4 additions & 3 deletions docs-v2/guides/integrate.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: 'How To Integrate Nango'
sidebarTitle: 'How To Integrate Nango'
description: 'Nango centralizes data transfer between external APIs and your app.'
description: 'Nango unifies interactions between your app and external APIs.'
---

<Frame caption="The steps to integrate Nango.">
<img src="/images/nango-data-flow.png" />
</Frame>

## 1. Get user permission from your site
## 1. Get user permission in your app

Integrate the Nango frontend SDK into your application to get user permission to access their data.

Expand All @@ -18,7 +18,8 @@ Store `connectionId` & `integrationId` in your database. You'll need these to ge
const integrationId = 'zendesk';
const connectionId = 'user123';

const result = await nango.auth(integrationId, connectionId);
// Show authorization popup.
const result = await nango.auth(integrationId, connectionId);

if (result.ok) {
saveToDatabase(connectionId, integrationId);
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/guides/sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Nango also sends [webhooks](/guides/webhooks) whenever new/updated/deleted recor

## Next Steps

Dive deeper with the [Customize Syncs & Actions guide](/guides/custom-script). Explore the [Field Mapping guide](/guides/sync) or the [Webhooks guide](/guides/webhooks).
Dive deeper with the [Customize Syncs & Actions guide](/guides/custom). Explore the [Field Mapping guide](/guides/sync) or the [Webhooks guide](/guides/webhooks).

## Questions, problems, feedback?

Expand Down
Binary file modified docs-v2/images/nango-data-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/images/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 18 additions & 79 deletions docs-v2/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,96 +1,35 @@
---
title: 'Introduction'
sidebarTitle: 'Introduction'
description: 'Nango: One platform for all your integrations.'
---

Nango simplifies integrating your product with any external API. It's as flexible as building integrations yourself and as quick as choosing a pre-existing solution. This means you can:
Nango is your one-stop-shop for handling all things related to external APIs. It should be the only API you need to integrate to your app.

* Build the integrations your customers need
* Clean up your codebase
* And get a good night's sleep!
<Frame caption="One API, many integrations.">
<img src="/images/overview.png" />
</Frame>

## 👀 An Overview of Nango
## 👨‍✈️ Choose your level of service

With Nango, you can construct integrations in hours, not weeks, while retaining complete control over the integration's logic and access to all external APIs.
Nango's versatility ensures it can accommodate any API integration:

Nango merges production-ready infrastructure with [pre-build integration templates](/integration-templates/overview) for [over 100 APIs](/integrations/overview):
1. **Pre-built integrations**: Utilize pre-built integrations for popular APIs and standard use-cases to ship fast.
2. **Custom integrations**: Build your own integrations with limitless customization capabilities.
3. **Managed integrations**: Leverage Nango experts to create and maintain your integrations end-to-end.

* 🔐 Authenticate 100+ APIs with just one line of code
* 🔁 Enable bi-directional data synchronization
* ⏩️ Easily access unified APIs for any category
* 🚫 Automate API-specific rate limits, retries & pagination
* 🧠 Apply strong typing with your custom data models
* 🪝 Utilize webhooks & real-time data syncs
* 👀 Take advantage of built-in monitoring
* 📺 Access your admin dashboard
## 🔌 100+ pre-built APIs & integrations, or build your own!

You'll have full control over the integrations without the headache of maintenance and ops.
[Over 100 APIs are pre-configured](https://nango.dev/integrations) to work right out of the box. We support 25+ categories such as **CRMs** (Hubspot, Salesforce), **sales intelligence** (Gong), **knowledge bases** (Notion, Drive), **ticketing** (Linear, Jira), **support** (zendesk), **communications** (Slack, Discord, Teams), **video** (zoom), **emails** (Gmails, Outlook), and [many more](/integrations).

## 👩‍💻 Sample Code with Nango

* A single line to initiate a new OAuth flow & connect an integration:
But remember! Nango works with **any API and any use-case**. Adding an API or integration is simple: [request it](https://nango.dev/request), [build your own](/guides/custom) or [contribute it](/contribute).

```js
nango.auth('github', '<user-id>');
```
## 🚀 Get Started

* A single line to fetch structured objects from any external API:

```ts
nango.getRecords<GithubIssue>({
providerConfigKey: 'github',
connectionId: '<user-id>',
model: 'GithubIssue', // Or any other data you want to sync
});
```

## 🚀 Get Up and Running with Nango

You can get Nango up and running in just 10 minutes with the [Quickstart 🚀](/quickstart).

For more detail:
You can get Nango up and running in just 3 minutes with the [Quickstart 🚀](/quickstart) guide.

For more details:
* Learn [how to integrate Nango](/guides/integrate)
* Explore the [integration templates](/integration-templates/overview)
* Check out the [100+ supported APIs](https://nango.dev/integrations)

## ✅ Over 100 Pre-configured APIs, Easy to Add Your Own

Nango works with any API and use-case. Adding an API is simple, and we already have many APIs covered.

[Over 100 APIs are pre-configured](https://nango.dev/integrations) to work right out of the box, including:

* **CRM**: Front, Hubspot, Salesforce, and more
* **Accounting**: Xero, Sellsy, Zoho Books, and more
* **Fintech:** Brex, Stripe, Braintree, Ramp, and more
* **Developer tools**: GitHub, GitLab, Linear, Jira, and more
* **Communication**: Gmail, Microsoft Teams, Slack, Discord, Zoom, and more
* **Productivity**: Asana, Airtable, Google Drive, Google Calendar, Trello,
GSheet, ClickUp, and more
* **Social**: Twitter, LinkedIn, Reddit, Facebook, and more
* [and many others...](/integrations)

If your favorite API is not listed, you can [open a GitHub issue](https://github.com/NangoHQ/nango/issues/new) or [contribute it](/contribute).

## 🕐 When is Nango the Right Choice?

Consider Nango if:

* You need to build integrations quickly
* Pre-packaged solutions such as embedded iPaaS or unified APIs are too restrictive
* You want to minimize maintenance overhead in production

Nango is primarily for SaaS products where integrations are at the heart of the user experience. If your product deeply integrates with other SaaS products, Nango is likely your best bet.

However, Nango is not designed for automating internal workflows or adding single sign-on login options.

## 🙋‍♀️ Why is Nango Open-Source?

At Nango, we believe all software should integrate seamlessly with the other software its users utilize. Integrations are core features in software products and as such should be built by engineers.

Our mission is to simplify the process for engineers to incorporate these integrations into their products with an open platform.

With our open-source approach, every engineer can contribute improvements to the platform for everyone:

* [Contribute](contribute) new APIs & integrations
* Share [API-specific quirks](/integrations/all/salesforce#api-gotchas) with other developers
* Join & ask any question on the [community](https://nango.dev/slack)
* Book a [demo](https://nango.dev/call)
2 changes: 1 addition & 1 deletion docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
"guides/action",
{
"group": "Other Guides",
"pages": ["guides/proxy", "guides/webhooks", "guides/custom-script", "guides/advanced-auth", "guides/field-mapping", "guides/api-key", "guides/env-vars", "contribute"]
"pages": ["guides/proxy", "guides/webhooks", "guides/custom", "guides/advanced-auth", "guides/field-mapping", "guides/api-key", "guides/env-vars", "contribute"]
}, {
"group": "Integration Templates",
"pages": [
Expand Down

0 comments on commit 3f1915d

Please sign in to comment.