Skip to content

docs: add connector.mdx for baton-file#45

Merged
luisina-santos merged 2 commits into
mainfrom
cxp-734/update-docs
Jul 2, 2026
Merged

docs: add connector.mdx for baton-file#45
luisina-santos merged 2 commits into
mainfrom
cxp-734/update-docs

Conversation

@carolinaroncaglia

Copy link
Copy Markdown
Contributor

What

Adds docs/connector.mdx for baton-file — the standard C1 customer-facing connector docs page. The repo previously shipped only per-format instruction docs (docs/{csv,excel,json,yaml}_instructions.md) and had no connector.mdx, despite the connector-docs verify workflow expecting one.

Contents

  • Overview — read-only file connector; YAML / JSON / JSONC / CSV / XLSX input; five-section data model.
  • Capabilities table — sync-only; dynamic resource types (user / group / role / app / secret); no provisioning.
  • Limitations — read-only, full-sync-only, file-defined data.
  • Configure — self-hosted / service-mode setup via the generic "Baton" tile, plus local file-mode usage.

Relates to CXP-734.

🤖 Generated with Claude Code

Adds the standard C1 customer-facing connector docs page for baton-file,
which previously shipped only per-format instruction docs. Covers overview,
supported input formats, capabilities (sync-only; dynamic resource types),
limitations, and self-hosted / service-mode setup via the generic "Baton" tile.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linear-code

linear-code Bot commented Jul 2, 2026

Copy link
Copy Markdown

CXP-734

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Connector PR Review: docs: add connector.mdx for baton-file

Blocking Issues: 0 | Suggestions: 0 | Threads Resolved: 0
Criteria: Criteria status: loaded .claude/skills/ci-review.md from trusted base a7d5c5b0194c.
Review mode: incremental since 338acde
View review run

Review Summary
This is a docs-only PR; the full PR diff was scanned for security and correctness and touches only docs/connector.mdx (no Go code, no go.mod/go.sum). The new commits reworded the title to "Set up a File connector", reframed the "Limitations" heading as a bold "Notes:" block, added a "Gather File connector credentials" section, and wrapped the configuration steps in Cloud-hosted/Self-hosted <Tabs>. The <Tabs>/<Tab> markup is balanced and correctly closed, and the content accurately reflects the self-hosted, sync-only, no-vendor-API nature of the connector. No new issues found.

Security Issues
None found.

Correctness Issues
None found.

Suggestions
None.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking issues found.

Align docs/connector.mdx with the repo's docs skill and standard
connector template: add the missing article to the title ("Set up a
File connector"), fold the freestanding Limitations section into a
Notes block under Capabilities, add a Gather credentials section
explaining the connector has no vendor API credentials, and wrap
Configure the File connector in Cloud-hosted/Self-hosted Tabs (marking
Cloud-hosted unavailable since the connector must read a local file).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking issues found.

@luisina-santos luisina-santos merged commit 17cae3d into main Jul 2, 2026
11 checks passed
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.

2 participants