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
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Claire documentation

Public documentation source for [Claire](https://tryclaire.net), rendered by Claire at
Public documentation source for [Claire](https://tryclaire.net), published at
[docs.tryclaire.net](https://docs.tryclaire.net). Start with the [Introduction](docs/index.md).

## Contribute
Expand All @@ -21,13 +21,13 @@ External URLs are not fetched, so provider outages cannot block a documentation
Review external links and the rendered page when changing them.

Keep existing paths stable. Use relative Markdown links, such as `../sources/telegram.md`.
Pages use `title`, `description`, `icon` and `order` front matter; `index.md` is a section's landing page and may add `tab` to place the section under a top tab. Docs can use cards, steps, tabs and collapsible sections; see the [rich content guide](docs/publishing/rich-content/index.md).
Pages use `title`, `description`, `icon` and `order` front matter; `index.md` is a section's landing page and may add `tab` to place the section under a top tab. Pages can use cards, steps, tabs and collapsible sections, as the existing pages do.
Use ordinary Markdown rather than executable MDX components. Repository housekeeping belongs
outside `docs/` so it is not published as a product page.

Screenshots live in `docs/images/` and are linked with relative Markdown image syntax, such as
`![Alt text](../images/token-page.webp)` (one more `../` from a page in a subfolder); raw HTML `<img>` tags are not resolved. Claire serves
them from this public repository's `main` branch, so an image appears once its change is merged.
`![Alt text](../images/token-page.webp)` (one more `../` from a page in a subfolder); raw HTML `<img>` tags are not resolved.
An image appears once its change is merged to `main`.
Use PNG or WebP under 250 KB, crop to the relevant component, and write descriptive alt text.
Public screenshots must not show test funds, local-fork labels, chain ids of test networks,
test accounts or internal organization names.
Expand All @@ -39,14 +39,9 @@ and requires no provider or deployment secrets.

## Publishing

This repository (`tryclaire/docs`, branch `main`, folder `docs`) is the connected source for
[docs.tryclaire.net](https://docs.tryclaire.net). Merging to `main` with changes under `docs/`
enqueues a Claire sync; pages publish without a separate approval step. CI checks the
repository but does not publish anything.

After merging, check the Docs sync status and the rendered navigation before announcing
a change as live. Do not document rollout-gated features (such as Ethereum/Stockereum
availability) as generally available until they are verified in production.
The documentation site is built from this repository (branch `main`, folder `docs`). CI checks
the repository but does not publish anything. Do not document rollout-gated features (such as
Ethereum/Stockereum availability) as generally available until they are verified in production.

## License

Expand Down
8 changes: 4 additions & 4 deletions docs/api/claire-proof.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Claire Proof endpoint
description: Read the linked token's Claire Proof, the on-chain facts its public site shows, from the chain at one block.
description: Read the linked token's Claire Proof, the on-chain facts its public proof page shows, from the chain at one block.
icon: shield
order: 46
---
Expand All @@ -9,13 +9,13 @@ order: 46

## Read the Claire Proof

`GET /api/v1/token/proof` (MCP tool `get_token_proof`, scope `token:read`) returns the [Claire Proof](../sources/token-actions/claire-proof.md) for the organization's linked token, the facts its public site shows plus the detail behind them, with `data` set to `null` when no token is linked. Unlike the other token reads it makes RPC requests: the on-chain figures come from one read at one block, stated in `block`, and are cached briefly. It returns:
`GET /api/v1/token/proof` (MCP tool `get_token_proof`, scope `token:read`) returns the [Claire Proof](../sources/token-actions/claire-proof.md) for the organization's linked token, the facts its public proof page shows plus the detail behind them, with `data` set to `null` when no token is linked. Unlike the other token reads it makes RPC requests: the on-chain figures come from one read at one block, stated in `block`, and are cached briefly. It returns:

- `chainId`, `network`, `explorer`, `url` (the token's permalink `/proof/<chainId>/<token>`, which opens the project's public site; append `/badge.svg` for the badge), `token` (`address`, `name`, `symbol`, `decimals`, `totalSupply`) and `block` (`number`, `time`).
- `chainId`, `network`, `explorer`, `url` (the token's permalink `/proof/<chainId>/<token>`, the token's public proof page; append `/badge.svg` for the badge), `token` (`address`, `name`, `symbol`, `decimals`, `totalSupply`) and `block` (`number`, `time`).
- `claire`: whether the token's launch is registered by a Claire router factory (launched or migrated), and `launch` when it is (`router`, `launchpad`, `creator`, `payee`, `payeeKind` of `creator`, `vault`, `split` or `other`, `holderBps`, `buyback`, `pendingPayee` and `migrated`). `payee` and `holderBps` are the current values. `launch.pendingPayee` is `null` or `{ address, kind, effectiveAt }`, the payee change the creator has announced and the time it can take effect. `launch.migrated` is `null` for a token launched through Claire; for a token brought over with `adopt` it holds `at` (ISO time of the adoption block, or `null` if it could not be read) and `block`. A linked token that never migrated is not registered.
- `locked`: raw amounts held by the time, revenue and price lock contracts for this token (`time`, `revenue`, `price`, `total`), `percent` of total supply (`null` when supply is zero), and the organization's published `locks` with their proof URLs. Vested but unclaimed tokens are included.
- `openingLock` (from the confirmed launch receipt, or `null`), `ponsLocked` (the supply pons' locker holds), `revenue` (the distributor, per asset what the router counted as `routed` and the cumulative total `published` to holders, and the confirmed `rounds` with `evidence` and `manifestUrl`) and `feeRecipient` (the launchpad's creator-fee recipient, `ok` when it is the Claire router, and any `pending` change).
- `contracts` (the lock and proof-view contracts it read) and `links` (the X account, Telegram chat and domain the organization connected inside Claire, which are not on-chain facts). Take verification addresses from `@tryclaire/sdk/protocol`, not from this response.
- `contracts` (the lock and proof-view contracts it read) and `links` (the X account and Telegram chat the organization connected inside Claire, which are not on-chain facts). Take verification addresses from `@tryclaire/sdk/protocol`, not from this response.

```sh
curl --header "Authorization: Bearer $CLAIRE_API_KEY" "$CLAIRE_API_URL/token/proof"
Expand Down
2 changes: 1 addition & 1 deletion docs/api/context-and-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 43

# Context and search

For document search, use an API-enabled key with `context:read` and `knowledge:read`, and turn on **Agents read** for Documents. `context:read` alone does not expose documents. Set `CLAIRE_API_URL` to the API base URL shown under **Developers → Connect** (API), including `/api/v1`, and set `CLAIRE_API_KEY` in your secret environment:
For Knowledge search, use an API-enabled key with `context:read` and `knowledge:read`, and turn on **Agents read** for the source. `context:read` alone does not expose any source. Set `CLAIRE_API_URL` to the API base URL shown under **Developers → Connect** (API), including `/api/v1`, and set `CLAIRE_API_KEY` in your secret environment:

```sh
curl --header "Authorization: Bearer $CLAIRE_API_KEY" \
Expand Down
1 change: 0 additions & 1 deletion docs/automations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ The Developers API and MCP connections are read-only; enabling Agent access does
| Trigger | Event |
| --- | --- |
| Authored X activity | A post or reply from the connected X account, not an incoming mention. |
| Docs publication | A docs page's first publication. |
| Join portal | A join approved through the portal. |
| Weekly schedule | A scheduled rule trigger, not permission for Claire to write on X. |

Expand Down
2 changes: 1 addition & 1 deletion docs/automations/reports-and-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Your notification bell holds workspace updates. Notification delivery is separat

## Set notification preferences

Email and Telegram direct-message delivery have per-user preferences by notification kind. In-app records remain visible independently. Failed automation runs, failing X collection, and domain errors queue delivery immediately; other updates queue later.
Email and Telegram direct-message delivery have per-user preferences by notification kind. In-app records remain visible independently. Failed automation runs, and failing X collection queue delivery immediately; other updates queue later.

Telegram DMs only reach accounts that pressed **Start** on Claire's bot. Delivery may be delayed by provider failures or channel limits.
8 changes: 4 additions & 4 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 2

# Getting started

Your personal space and organization workspaces are separate. Personal navigation contains your Home, Referrals, Wallet, [$CLAIRE](../claire/index.md) and account settings. An organization's sidebar starts with Home, Token, Community (Telegram), Social (X) and People; then Knowledge, Automations and Developers; then Site, Docs and Assets; and Settings last. Create or choose a workspace for your project. You do not need to link a token to use Telegram, X, Knowledge, or the site.
Your personal space and organization workspaces are separate. Personal navigation contains your Home, Referrals, Wallet, [$CLAIRE](../claire/index.md) and account settings. An organization's sidebar starts with Home, Token, Community (Telegram), Social (X) and People; then Knowledge, Automations and Developers; then Assets; and Settings last. Create or choose a workspace for your project. You do not need to link a token to use Telegram, X, or Knowledge.

## Create a workspace

Expand All @@ -27,7 +27,7 @@ Owners and admins can use the optional **Getting started** sidebar checklist. Hi

![The Finish setting up checklist on a workspace's Home page, grouped under Connect, Publish, Team and Optional, with a Connect Telegram shortcut.](../images/getting-started-checklist.webp)

Claire uses a dark interface. Appearance offers preset or custom accent colours for this browser, not an account-wide theme or a change to your public site's appearance.
Claire uses a dark interface. Appearance offers preset or custom accent colours for this browser, not an account-wide theme.

## Invite teammates

Expand Down Expand Up @@ -63,8 +63,8 @@ You can do these in any order.
Follow your community's messages and people.
::card[Connect X]{href=../sources/x.md#connect-an-account icon=x}
Inspect an account's collected activity.
::card[Set up your site]{href=../publishing/site-and-domains.md icon=globe}
Publish a public profile and docs.
::card[Control what agents can read]{href=../sources/context.md#decide-what-to-include icon=lock}
Choose which sources Claire uses and which agents may read.
:::

For optional token tools, [verify a wallet and launch or vest a supported token](../sources/token-actions/signing-wallet.md) when your chosen network is available.
Expand Down
11 changes: 4 additions & 7 deletions docs/getting-started/security-and-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,25 @@ order: 3

# Security and data

Workspace content is available to authorized members, while sensitive management actions require owner or admin access. Public profiles, published docs, public asset URLs and published vesting proofs are separate public surfaces.
Workspace content is available to authorized members, while sensitive management actions require owner or admin access. Claire Proof pages, public asset URLs and published vesting proofs are separate public surfaces.

## Control workspace access

Only the owner can change another member's role or transfer ownership. Developer credentials belong to one workspace, have explicit read scopes and require the issuing manager to keep their role. The **Developers** page sets each key to API, MCP or both; pre-existing keys remain API-only. A source must be used (**Claire uses**) and separately approved for agents (**Agents read**, off by default) in **Knowledge**, in addition to matching scopes.

A Knowledge item's **public reference** classification does not publish it or grant public access. Unpublished docs drafts are private on the site, but **private/unpublished is not integration-private**: approving Agent access for Documents or Notes lets credentials with `knowledge:read` read private drafts or team notes, and agent providers may receive that content. Approving Telegram chats likewise lets credentials with `telegram:read` read stored conversations, including private linked groups or channels. External People reads still exclude private person notes. A file explicitly marked **public** in Assets has a public file URL; do not mark confidential files public. Relative images imported with GitHub docs are copied into public Assets.
A Knowledge item's **public reference** classification does not publish it or grant public access. **Private is not integration-private**: approving Agent access for Notes lets credentials with `knowledge:read` read team notes, and agent providers may receive that content. Approving Telegram chats likewise lets credentials with `telegram:read` read stored conversations, including private linked groups or channels. External People reads still exclude private person notes. A file explicitly marked **public** in Assets has a public file URL; do not mark confidential files public.

Only an owner designates a [token signing wallet](../sources/token-actions/signing-wallet.md), separately for each chain. Owners and admins can prepare token actions and publish vesting links, but the designated wallet must sign organization transactions. Removing app access does not revoke wallet keys or on-chain rights.

Funding a lock exposes addresses, amounts, and its schedule on-chain even without a Claire proof page. Publishing additionally lists a public proof on the site; unpublishing does not make the underlying on-chain data private. A proof is not a liquidity lock or investment guarantee.
Funding a lock exposes addresses, amounts, and its schedule on-chain even without a Claire proof page. Publishing additionally lists the lock on the token's Claire Proof page and gives it a public proof page; unpublishing does not make the underlying on-chain data private. A proof is not a liquidity lock or investment guarantee.

The official [`@tryclaire/sdk`](../api/index.md) is a REST client for scoped API keys, not an MCP client or an additional grant of access. [Native MCP](../mcp/index.md) uses its own method permission on a shared workspace credential. Keep keys out of browser bundles, public variables and source control. Installing the package does not connect a workspace or create a credential.

> [!WARNING]
> GitHub docs publish as soon as they sync, including docs from private repositories. See [Docs from GitHub](../publishing/github-docs.md) before syncing confidential material.

## Understand stored data

Claire retains connected source data and operational records. A linked Telegram chat's messages and activity are stored from the time the bot joins. Disconnecting a source does not automatically delete collected history. Turning a source off in Knowledge does not disconnect or delete it.

GitHub docs and team notes have different origins: edit synced docs at their repository source, while notes can be edited in Claire. Asset metadata does not mean Claire has indexed or read the asset's contents. External People reads expose only approved Telegram/X activity and platform identities, not Claire profiles, private person notes or live avatars.
Asset metadata does not mean Claire has indexed or read the asset's contents. External People reads expose only approved Telegram/X activity and platform identities, not Claire profiles, private person notes or live avatars.

## Know what Claire does not do

Expand Down
Binary file removed docs/images/insert-menu.webp
Binary file not shown.
Binary file removed docs/images/rich-content-rendered.webp
Binary file not shown.
17 changes: 8 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ order: 1

All-in-one infrastructure layer for teams, communities, and on-chain participants.

Claire brings Telegram and X activity, supported token observations, team context, and public docs into one workspace. Teams can maintain a public profile and use wallet-signed token launches and vesting where available. Token tools are optional.
Claire brings Telegram and X activity, supported token observations, and team context into one workspace. Teams can use wallet-signed token launches and vesting where available. Token tools are optional.

Your personal account is separate from workspaces. Each workspace has its own members, integrations, site, docs, assets, and access controls. You can belong to more than one workspace.
Your personal account is separate from workspaces. Each workspace has its own members, integrations, assets, and access controls. You can belong to more than one workspace.

## Explore the essentials

Expand All @@ -22,8 +22,8 @@ Your personal account is separate from workspaces. Each workspace has its own me
Create a workspace, invite your team and understand roles.
::card[Sources]{href=sources/index.md icon=plug}
Telegram, X, token data, Knowledge, and Assets.
::card[Publishing]{href=publishing/index.md icon=globe}
A public profile and docs from Claire or GitHub.
::card[Token actions]{href=sources/token-actions/index.md icon=coin}
Wallet-signed launches, locks, payout rounds and Claire Proof.
:::

## What would you like to do?
Expand All @@ -37,8 +37,8 @@ Add Claire's bot to a group or channel and follow its activity.
Prove control of an account and inspect its collected activity.
::card[Control what agents can read]{href=sources/context.md#decide-what-to-include icon=lock}
Choose which sources Claire uses and which agents may read.
::card[Publish your docs]{href=publishing/github-docs.md#connect-a-repository icon=github}
Sync a public or private GitHub repository into your site.
::card[Share a Claire Proof]{href=sources/token-actions/claire-proof.md#badge-and-sharing icon=shield}
Share a token's public proof page and badge.
::card[Automate a Telegram post]{href=automations/index.md#enable-a-rule icon=bolt}
Post or pin text in a linked chat when a trigger fires.
::card[Launch a token]{href=sources/token-actions/launch.md#launch-steps icon=coin}
Expand All @@ -51,13 +51,12 @@ Read approved sources over REST or native MCP with a scoped credential.

| Part | What you use it for |
| --- | --- |
| **Workspace** | Members, integrations, site, docs, assets and access controls for one project. |
| **Workspace** | Members, integrations, assets and access controls for one project. |
| **Sources** | Telegram chats, an X account and an optional pons token whose activity Claire collects. |
| **Knowledge and Assets** | What Claire knows about your project and which sources agents may read. |
| **Site and Docs** | Your public profile, published docs and custom domains. |
| **Automations** | Explicitly enabled Telegram rules that run on a source event or weekly schedule. |
| **Developer API and MCP** | Read-only access to approved sources with scoped credentials. |
| **Token actions** | Wallet-signed launches, locks, payout rounds and Claire Proof on your public site. |
| **Token actions** | Wallet-signed launches, locks, payout rounds and a public Claire Proof page per token. |

Connecting a source does not automatically permit external agent access. [Knowledge and Assets](sources/context.md) explains the switches that control it.

Expand Down
Loading
Loading