Skip to content

Commit

Permalink
🐛 Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
naelob committed May 23, 2024
1 parent 7d65840 commit d879f11
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/glossary/metadata/category.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Categories"
description: "All categories across Panora"
icon: layer-group
---

## Categories powering the Panora API

All values are derived from `ConnectorCategory` found in the `@panora/shared` package which can be found [here](https://www.npmjs.com/package/@panora/shared).

```ts
export declare enum ConnectorCategory {
Crm = "crm",
Hris = "hris",
Ats = "ats",
Accounting = "accounting",
Ticketing = "ticketing",
MarketingAutomation = "marketingautomation",
FileStorage = "filestorage"
}
```
15 changes: 15 additions & 0 deletions docs/glossary/metadata/connectors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Connectors"
description: ""
icon: circle-nodes
---

## Connectors powering the Panora API

All connectors are within the `@panora/shared` (in the `metadata.ts` file) package which can be found [here](https://www.npmjs.com/package/@panora/shared).

The **source of truth** is contained within this [**object**](https://github.com/panoratech/Panora/blob/main/packages/shared/src/connectors/metadata.ts#L6) :

```ts
CONNECTORS_METADATA: ProvidersConfig
```
6 changes: 5 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,11 @@
},
{
"group": "Glossary",
"pages": ["glossary/connection-object", "glossary/linked-account-object"]
"pages": ["glossary/connection-object", "glossary/linked-account-object",
{
"group": "Metadata",
"pages": ["glossary/metadata/category", "glossary/metadata/connectors"]
}]
},

{
Expand Down

0 comments on commit d879f11

Please sign in to comment.