Skip to content

docs(communication): fix inaccurate output columns, broken links, and typos#973

Draft
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1781879316-communication-docs-audit
Draft

docs(communication): fix inaccurate output columns, broken links, and typos#973
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1781879316-communication-docs-audit

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-349

Changes:

Unambiguous doc fixes found during code-vs-docs accuracy audit of components/extractors/communication/ against source repos (keboola/component-email-content, keboola/gmail-extractor, keboola/ex-email-attachments).

Code-accuracy fixes (verified against source):

  • email-imap + ms-outlook output columns: add 3 missing columns (subject, body_html, attachment_names) — code produces 13 cols, docs only listed 10. Evidence: component-email-content/src/component.py:13-27 RESULT_COLUMNS
  • ms-outlook broken link: relative query-syntax resolved to non-existent ms-outlook/query-syntax; fixed to absolute /components/extractors/communication/email-imap/query-syntax/ (matches code's own link in configRowSchema.json:22)
  • gmail copy-paste error: "Google Analytics connector" → "Gmail Messages connector" (step 7 of OAuth setup)
  • email-attachments table naming: data1dataNdata, data1, data2… (matches RunAction.php:180-184 counter logic)

Structural fixes:

  • Add missing IMAP Email connector to communication/index.md listing
  • Fix trailing slash on google-calendar link in index
  • Add 22 missing | --- | --- | table header separators in intercom/index.md (tables rendered as plain text without them)

Typos:

  • specificlyspecifically, entereenter, msutmust (×2), matchessmatches, XSLXXLSX (×2)

NOT included (need human decision):

  • MS Outlook Graph API connection method (undocumented feature — document now or wait?)
  • Attachment pattern UI default discrepancy (.+\\.csv in schema vs empty in code)
  • Email-attachments MIME type (docs say CSV only, code accepts any text/*)

See PRDCT-349 comment for full audit with code evidence table."

Link to Devin session: https://app.devin.ai/sessions/d709d381ecb94f0a80770c4a3db48337
Requested by: @Iamfle4ka

… typos

Audited communication extractor docs against source code. Fixes:
- Add 3 missing output columns (subject, body_html, attachment_names) to
  email-imap and ms-outlook (matches component-email-content/src/component.py)
- Fix broken query-syntax link in ms-outlook (relative → absolute path to
  email-imap/query-syntax/)
- Fix copy-paste error in gmail: 'Google Analytics' → 'Gmail Messages'
- Fix table naming in email-attachments: data1–dataN → data, data1, data2
  (matches RunAction.php counter logic)
- Add missing IMAP connector to communication/index.md listing
- Fix trailing slash on google-calendar link
- Add missing table header separators in intercom (22 tables)
- Fix typos: specificly, entere, msut, matchess, XSLX

Fixes PRDCT-349

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jun 19, 2026 2:32pm

Request Review

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.

1 participant