docs: add pipedrive documentation#2743
Conversation
marcel-rbro
left a comment
There was a problem hiding this comment.
A few line-level suggestions below. The indentation one on the deduplication list is the only blocker (it fails pnpm lint:md); the rest are small active-voice/wording cleanups you can accept inline.
| - **Overwrite existing data** | ||
| - **Auto-fill only empty fields** | ||
| - **Skip existing records** |
There was a problem hiding this comment.
This fails CI (pnpm lint:md, rule MD007/ul-indent). Nested bullets should be indented 2 spaces, not 4. Dropping the indent to 2 fixes it.
| - **Overwrite existing data** | |
| - **Auto-fill only empty fields** | |
| - **Skip existing records** | |
| - **Overwrite existing data** | |
| - **Auto-fill only empty fields** | |
| - **Skip existing records** |
| - **Leads per organization**: how many contacts to find per organization, from 1 to 100. | ||
| - **Departments**: which company departments to target. | ||
| - **Social media profiles**: which profiles to collect. | ||
| - **Deduplication mode**: how existing Pipedrive values are handled. You have to choose one of: |
There was a problem hiding this comment.
Two small style tweaks: we favor active voice, so "are handled" becomes "the app handles"; and "You have to choose one of" is more direct as just "Choose one of".
| - **Deduplication mode**: how existing Pipedrive values are handled. You have to choose one of: | |
| - **Deduplication mode**: how the app handles existing Pipedrive values. Choose one of: |
|
|
||
| :::caution Organizations need a website | ||
|
|
||
| Contact enrichment starts from an organization's website URL. Organizations without a website are skipped, and the review step lists how many will be skipped. |
There was a problem hiding this comment.
Active voice reads cleaner here — make "the app" the subject instead of "are skipped".
| Contact enrichment starts from an organization's website URL. Organizations without a website are skipped, and the review step lists how many will be skipped. | |
| Contact enrichment starts from an organization's website URL. The app skips organizations without a website, and the review step lists how many it will skip. |
| Each run reports its status and a summary of what changed: | ||
|
|
||
| - **Statuses**: a run shows as **Processing** while it works, then **Done** or **Failed**. | ||
| - **Results summary**: items (contacts + organizations) added, updated, skipped, and failed. |
There was a problem hiding this comment.
A + sign looks informal in prose — spell it out as "and".
| - **Results summary**: items (contacts + organizations) added, updated, skipped, and failed. | |
| - **Results summary**: items (contacts and organizations) added, updated, skipped, and failed. |
|
|
||
| ## Limitations | ||
|
|
||
| - Organizations without a website URL are skipped, because contact enrichment starts from the organization's website. |
There was a problem hiding this comment.
Active voice: let "the app" do the skipping.
| - Organizations without a website URL are skipped, because contact enrichment starts from the organization's website. | |
| - The app skips organizations without a website URL, because contact enrichment starts from the organization's website. |
| - Organizations without a website URL are skipped, because contact enrichment starts from the organization's website. | ||
| - The number of leads per organization must be between 1 and 100. | ||
| - A configuration needs at least one fully configured field mapping before you can save it. | ||
| - Enrichment runs asynchronously, so results are written back to Pipedrive only after the run finishes. |
There was a problem hiding this comment.
Active voice: "the app writes" instead of "results are written back".
| - Enrichment runs asynchronously, so results are written back to Pipedrive only after the run finishes. | |
| - Enrichment runs asynchronously, so the app writes results back to Pipedrive only after the run finishes. |
Add documentation for the upcoming Pipedrive integration.