Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 13 additions & 21 deletions .agents/skills/create-pr/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
---
name: create-pr
description: Prepare or update a pull request with focused validation, current ADRs, and a complete PR update record.
description: Create or update a documentation PR without publishing internal engineering records.
---

# Create or update a pull request
# Create or update a documentation PR

## Repository documentation requirements
Follow [docs/README.md](../../../docs/README.md). Do not create, copy, commit, or
publish `docs/adrs/` or `docs/updates/`, including templates and historical files.
Keep architecture decisions and complete update records in the owning source
repository; record docs-only changes and validation in the PR body.

Follow [docs/README.md](../../../docs/README.md) for every change in this workflow. Create or update
ADRs for resolved durable decisions, keep affected README/setup/public docs current,
and maintain the complete pending or PR-numbered update record after every revision.
Use the shared templates and section names. Missing or stale required documentation
blocks completion. Document already authorized decisions without asking again; ask
only about unresolved choices. These requirements govern documentation instructions
elsewhere in this skill; preserve its repository-specific implementation and checks.
Inspect the actual base and preserve unrelated work. Verify public claims and
examples against source contracts, and update affected guides, setup instructions,
and navigation. Link companion API/SDK PRs and explain deployment order.

Inspect the actual base branch, current diff, existing PR, and unrelated workspace
changes. Complete authorized implementation and focused repository checks before
publishing. Follow `pre-commit-checks` and `maintain-docs`; include affected ADRs,
README/setup/public docs, and the pending update record in the reviewed diff.

When publishing is authorized, intentionally stage the task files, commit, push,
and open or update a draft PR. Read its actual number/URL, rename the pending record
to `docs/updates/<number>.md`, update its contents, and push it to the same PR. Link
that record and relevant ADRs/related PRs in the description. Recheck the full diff,
validation, and documentation after later review or rebase changes. Never include
unrelated work, secret values, or unverified claims. Do not merge unless authorized.
Run `npm run check:publication-boundary`, `mint validate`, `mint broken-links`,
`mint a11y`, and `git diff --check`. Report actual results and remaining external
publication work. When authorized, commit/push the reviewed files and create or
update the PR; do not add a PR-numbered update file. Merge only when authorized.
29 changes: 13 additions & 16 deletions .agents/skills/maintain-docs/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
---
name: maintain-docs
description: Maintain repository ADRs, change and PR update records, and affected setup/public docs while implementing or reviewing changes.
description: Maintain public documentation without publishing internal engineering records.
---

# Maintain repository documentation
# Maintain public documentation

Follow [docs/README.md](../../../docs/README.md), the shared documentation contract.
Read governing ADRs before implementation. Write accepted durable decisions in
`docs/adrs/`; amend current text and append timestamped history when they change.
Record already authorized decisions directly and ask only about unresolved choices.
Follow [docs/README.md](../../../docs/README.md). Do not create, copy, commit, or
publish `docs/adrs/` or `docs/updates/`, including templates and historical files.
Keep architecture decisions and complete update records in the owning source
repository; record docs-only changes and validation in the PR body.

Keep one complete update record using [the template](../../../docs/updates/template.md).
Before a PR exists, use `docs/updates/pending/<short-slug>.md`. After the authorized
PR is opened, rename it to `docs/updates/<actual-pr-number>.md` using the verified
number and URL. Refresh it after each revision; never invent a number or publish
solely to obtain one.
Inspect the actual base and preserve unrelated work. Verify public claims and
examples against source contracts, and update affected guides, setup instructions,
and navigation. Link companion API/SDK PRs and explain deployment order.

Review affected READMEs, setup/deployment instructions, generated contracts, and
public documentation. Update them in the same change, linking related repository
records and deployment order when applicable. Before handoff, compare the docs with
the complete final diff and report actual validation and remaining work. Missing
or stale required documentation blocks completion. Release notes remain separate.
Run `npm run check:publication-boundary`, `mint validate`, `mint broken-links`,
`mint a11y`, and `git diff --check`. Report actual results and remaining external
publication work. When authorized, commit/push the reviewed files and create or
update the PR; do not add a PR-numbered update file. Merge only when authorized.
32 changes: 13 additions & 19 deletions .agents/skills/pre-commit-checks/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,20 @@
---
name: pre-commit-checks
description: Validate the affected diff and required documentation before committing or completing a pull request.
description: Validate public documentation without publishing internal engineering records.
---

# Pre-commit checks
# Validate public documentation

## Repository documentation requirements
Follow [docs/README.md](../../../docs/README.md). Do not create, copy, commit, or
publish `docs/adrs/` or `docs/updates/`, including templates and historical files.
Keep architecture decisions and complete update records in the owning source
repository; record docs-only changes and validation in the PR body.

Follow [docs/README.md](../../../docs/README.md) for every change in this workflow. Create or update
ADRs for resolved durable decisions, keep affected README/setup/public docs current,
and maintain the complete pending or PR-numbered update record after every revision.
Use the shared templates and section names. Missing or stale required documentation
blocks completion. Document already authorized decisions without asking again; ask
only about unresolved choices. These requirements govern documentation instructions
elsewhere in this skill; preserve its repository-specific implementation and checks.
Inspect the actual base and preserve unrelated work. Verify public claims and
examples against source contracts, and update affected guides, setup instructions,
and navigation. Link companion API/SDK PRs and explain deployment order.

Inspect the complete task diff and preserve unrelated changes. Read the repository
instructions and run checks appropriate to the affected components. Fix in-scope
failures and distinguish pre-existing failures and unavailable external checks.

Follow `maintain-docs` before handoff: review governing ADRs, update durable decisions,
keep affected README/setup/public docs accurate, and refresh the current update
record. A missing or stale required record blocks completion. Check formatting,
links, generated artifacts, release-note obligations, and the final diff. Report
only checks actually run; do not publish or merge without existing authorization.
Run `npm run check:publication-boundary`, `mint validate`, `mint broken-links`,
`mint a11y`, and `git diff --check`. Report actual results and remaining external
publication work. When authorized, commit/push the reviewed files and create or
update the PR; do not add a PR-numbered update file. Merge only when authorized.
20 changes: 11 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
## Change
## Changes

Describe the problem and resulting behavior.
Describe the public documentation changes and their source contracts.

## Validation

Record checks actually run, their results, and any unverified flows.
- [ ] `npm run check:publication-boundary`
- [ ] `mint validate`
- [ ] `mint broken-links`
- [ ] `mint a11y`
- [ ] `git diff --check`

## Documentation
## Publication and related changes

- Link the current `docs/updates/<actual-pr-number>.md` record (rename the pending record after PR creation).
- Link new or amended ADRs under `docs/adrs/`, or state `ADR review: no new decision` with a reason.
- List affected README, setup/deployment, and public documentation changes; link related repository PRs and merge order.
- Confirm the update record describes the full current diff, actual validation, and required consumer/operator actions.
- Refresh this section and the same update record after subsequent review or rebase changes.
Link companion API/SDK PRs and explain deployment order or remaining release work.
Internal ADRs and update records belong in those source repositories. Do not add
`docs/adrs/` or `docs/updates/` files to this repository.
14 changes: 14 additions & 0 deletions .github/workflows/publication-boundary.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Public documentation boundary
on:
pull_request:
push:
branches: [main]
jobs:
publication-boundary:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 24
- run: npm run check:publication-boundary
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

# Internal engineering records belong in the owning source repository.
/docs/adrs/
/docs/updates/
5 changes: 4 additions & 1 deletion .mintignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@ AGENTS.md
drafts/
*.draft.mdx

# Internal repository decision and change records
# Internal maintenance policy; ADRs and update records are prohibited here.
docs/

docs/adrs/**
docs/updates/**
16 changes: 8 additions & 8 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This is the canonical Mintlify documentation repository for Tilde. Public guides
live in the root MDX pages and feature/guide directories; `docs.json` owns navigation.
Internal architecture and PR records live under `docs/adrs` and `docs/updates` and
are excluded from site publication by `.mintignore`.
Architecture decisions and detailed change records belong in the owning source
repository, never in this public docs repository.

## Documentation maintenance

For every change, follow [docs/README.md](docs/README.md) and
[maintain-docs](.agents/skills/maintain-docs/SKILL.md). Read governing ADRs, record
resolved durable decisions, maintain the current pending/PR-numbered update record,
and keep affected public pages and navigation synchronized. Do not ask again about
already-authorized decisions or preserve obsolete setup prompts.
Follow [docs/README.md](docs/README.md). Never create, copy, commit, or publish
`docs/adrs/` or `docs/updates/`, including historical records or templates.
Record docs-only intent, verification, and publication requirements in the PR
body. Link source-repository decisions/PRs when useful. Keep public pages,
examples, setup instructions, and navigation synchronized.

## Public content

Expand All @@ -30,6 +30,6 @@ already-authorized decisions or preserve obsolete setup prompts.
## Validation and publication

Run `mint validate`, `mint broken-links`, and `mint a11y` after content/navigation
changes. Review the final diff and keep the same update record current through PR
changes. Run `npm run check:publication-boundary` and review the final diff through PR
revisions. Use the [create-pr workflow](.agents/skills/create-pr/SKILL.md) when PR
publication is authorized; never fabricate a PR number or claim a deployment.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ Install Mintlify's documentation skill for your coding tools:
npx skills add https://mintlify.com/docs
```

## Internal records

Never store or publish `docs/adrs/` or `docs/updates/` in this repository. Keep
engineering decisions and change records in the owning source repository; use
this repository's PR descriptions for docs-only rationale and validation. Run
`npm run check:publication-boundary` before publishing. See [the publication
policy](docs/README.md).

## Publishing changes

Mintlify deploys committed changes through its GitHub app. Generated tool-provider files must be committed because Mintlify maps indexable routes to MDX files in the repository.
Expand Down
2 changes: 2 additions & 0 deletions chatkit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Signal provider instances and rules may also be personal. A personal rule names

Signal providers and rules use the same two planes. Visibility controls discovery and delivery inspection; ownership controls configuration, target/session policy, grants, state-changing retries, and deletion. Deliveries and sessions inherit the rule and target authorization rather than defining independent grants.

Build a customer-hosted integration with [custom ChatKit providers](/custom-chatkit-providers). Definitions are reusable within a team, and each connection has independent credentials and configuration.

## Set up ChatKit

<Steps>
Expand Down
Loading
Loading