Skip to content

docs: add built-in interfaces reference for Function service#27

Merged
jackchuka merged 3 commits into
mainfrom
docs/function-builtin-interfaces
Mar 17, 2026
Merged

docs: add built-in interfaces reference for Function service#27
jackchuka merged 3 commits into
mainfrom
docs/function-builtin-interfaces

Conversation

@jackchuka

@jackchuka jackchuka commented Mar 16, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a new Built-in Interfaces reference page (/guides/function/builtin-interfaces) documenting all global variables available inside Functions
  • Updates the Function overview page to prominently link to the new reference
  • Adds sidebar ordering so the page appears right after the overview

Interfaces documented

Interface Description
tailor.idp.Client IdP user management (CRUD + password reset emails)
tailor.secretmanager Vault secret retrieval
tailor.authconnection External auth connection tokens
tailor.iconv Character encoding conversion
tailor.workflow Workflow and job function triggers
tailordb.Client Direct SQL queries against TailorDB
tailordb.file File upload/download/stream/delete

Each interface includes a usage example, method/function table, and links to existing detailed guides where available.

Type information is sourced from @tailor-platform/function-types (tailor.d.ts).

Test plan

  • Verify the page renders correctly with pnpm dev
  • Check sidebar ordering (builtin-interfaces appears after overview)
  • Verify all internal links resolve
  • Confirm CI checks pass (schema, links, typos)

jackchuka and others added 3 commits March 16, 2026 21:02
Add a centralized reference page documenting all built-in interfaces
available as global variables in Functions (Resolvers, Workflows,
Executors): tailor.idp.Client, tailor.secretmanager,
tailor.authconnection, tailor.iconv, tailor.workflow, tailordb.Client,
and tailordb.file.

Also updates the Function overview page to link to the new reference.

Addresses tailor-professional-service/knowledge#63
Sidebar ordering only checked the top-level section name (e.g.,
"guides") against sidebarItemOrder, ignoring subdirectory-specific
orders like "function". Now checks current directory name first.

Nav links for sections without index.md used alphabetical sort,
landing on the wrong page. Now respects sidebarItemOrder and
defaultSidebarOrder to pick the correct first page.

Also links @tailor-platform/function-types to its GitHub source.
@jackchuka
jackchuka merged commit 3edb4ae into main Mar 17, 2026
3 checks passed
@jackchuka
jackchuka deleted the docs/function-builtin-interfaces branch March 17, 2026 00:27
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