Skip to content

[ENG-3760] docs: add v2.12.0 ConnectProvider module prop and headless updates#526

Merged
dionlow merged 6 commits intomainfrom
docs/v2.12.0-module-headless-updates
Mar 30, 2026
Merged

[ENG-3760] docs: add v2.12.0 ConnectProvider module prop and headless updates#526
dionlow merged 6 commits intomainfrom
docs/v2.12.0-module-headless-updates

Conversation

@dionlow
Copy link
Copy Markdown
Contributor

@dionlow dionlow commented Mar 16, 2026

Summary

  • Document the new module prop for ConnectProvider (module-specific metadata collection, auto-showing metadata form for existing connections)
  • Add getReadObjects to useManifest documentation (bulk retrieval of all read objects from manifest)
  • Add ensureObject and removeObject to useLocalConfig documentation (add/remove objects from draft config with manifest defaults)
  • Document useCreateInstallation auto-populating config.provider from the integration object

Test plan

  • Verify docs render correctly on Mintlify preview
  • Confirm code examples are syntactically correct
  • Check that new sections link properly from existing content

Document the new `module` prop for ConnectProvider, `getReadObjects` for
useManifest, `ensureObject`/`removeObject` for useLocalConfig, and
provider auto-populate behavior for useCreateInstallation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@dionlow dionlow requested a review from laurenzlong March 16, 2026 18:44
@dionlow dionlow changed the title docs: add v2.12.0 ConnectProvider module prop and headless updates [ENG-3760] docs: add v2.12.0 ConnectProvider module prop and headless updates Mar 16, 2026
@linear
Copy link
Copy Markdown

linear bot commented Mar 16, 2026

@laurenzlong laurenzlong removed their request for review March 18, 2026 00:18
@laurenzlong
Copy link
Copy Markdown
Contributor

@dionlow please re-request review once this has been updated with the new names.

Replace ensureObject with readObject().setEnableRead()/setDisableRead()
to match the write pattern naming. Remove mention of client-side required
fields pre-filling (backend handles defaults now). Add deleteFieldMapping
to ReadObjectHandlers docs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
v2.12.0 was unpublished; all features shipped in v2.12.1.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@dionlow
Copy link
Copy Markdown
Contributor Author

dionlow commented Mar 18, 2026

Ready for review. Broken links test fixed here: #530

Tighten module prop description, reduce redundancy in getReadObjects
section, restructure setEnableRead/setDisableRead/removeObject as a
bullet list with a Note callout for auto-enable behavior, and clarify
code example comments.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Lauren Long <laurenzlong@users.noreply.github.com>
@dionlow dionlow enabled auto-merge (squash) March 25, 2026 17:58
@dionlow dionlow merged commit bc32372 into main Mar 30, 2026
4 checks passed
@dionlow dionlow deleted the docs/v2.12.0-module-headless-updates branch March 30, 2026 17:04
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