docs: add feed documents

Author: moonrailgun

website/docs/feed/channels.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 2
+---
+
+# Channels
+
+Channels are containers of events. You can create multiple channels for different products/teams/environments.
+
+## Create a channel
+
+Console → Feed → Add Channel.
+
+Fields
+
+- name: Display name
+- notifyFrequency: Control how often notifications are sent for this channel
+- notificationIds: Select existing notification targets to receive fan-out
+
+## Edit a channel
+
+You can update name, notificationIds, notifyFrequency, and set an optional webhookSignature. Once a signature is set, any public webhook to this channel must include header `x-webhook-signature` with the same value.
+
+## API
+
+- List channels: GET `/open/workspace/{workspaceId}/feed/channels`
+- Channel info: GET `/open/workspace/{workspaceId}/feed/{channelId}/info`
+- Update: POST `/open/workspace/{workspaceId}/feed/{channelId}/update`
+- Create: POST `/open/workspace/{workspaceId}/feed/createChannel`
+- Delete: DELETE `/open/workspace/{workspaceId}/feed/{channelId}/del`
+
+Example (update notification targets)
+
+```bash
+curl -X POST \
+  "$BASE_URL/workspace/$WORKSPACE_ID/feed/$CHANNEL_ID/update" \
+  -H "Authorization: Bearer $TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "name": "Ops",
+    "notifyFrequency": 60,
+    "notificationIds": ["notif_123", "notif_456"]
+  }'
+```

website/docs/feed/integrations.md

@@ -0,0 +1,61 @@
+---
+sidebar_position: 5
+---
+
+# Integrations
+
+Tianji provides built-in webhook adapters to convert third-party payloads into Feed events.
+
+## GitHub
+
+Endpoint
+
+POST `/open/feed/{channelId}/github`
+
+Notes
+
+- Use "application/json" content type.
+- Header `X-GitHub-Event` is required by GitHub and consumed by the adapter.
+- Supported types: `push`, `star`, `issues` (opened/closed). Others will be logged as unknown.
+
+## Stripe
+
+Endpoint
+
+POST `/open/feed/{channelId}/stripe`
+
+Notes
+
+- Configure a Stripe webhook endpoint pointing to the URL above.
+- Supported types: `payment_intent.succeeded`, `payment_intent.canceled`, `customer.subscription.created`, `customer.subscription.deleted`.
+
+## Sentry
+
+Endpoint
+
+POST `/open/feed/{channelId}/sentry`
+
+Notes
+
+- Header `Sentry-Hook-Resource: event_alert` and action `triggered` are mapped to Feed events.
+- See step-by-step screenshots in "Integration with Sentry".
+
+## Tencent Cloud Alarm
+
+Endpoint
+
+POST `/open/feed/{channelId}/tencent-cloud/alarm`
+
+Notes
+
+- Supports alarm types `event` and `metric`. Payload is validated; invalid requests are rejected.
+
+## Webhook Playground
+
+Endpoint
+
+POST `/open/feed/playground/{workspaceId}`
+
+Notes
+
+- Echo headers/body/method/url to the workspace real-time playground for debugging integrations.

website/docs/feed/intro.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 0
+---
+
+# Feed overview
+
+Feed is a lightweight event stream for your workspace. It helps teams aggregate important events from different systems into channels, collaborate around incidents, and keep stakeholders informed.
+
+## Concepts
+
+- Channel: A logical stream to collect and organize events. Each channel can be connected to one or more notification targets and can optionally require a webhook signature.
+- Event: A single record with name, content, tags, source, sender identity, importance and optional payload. Events can be archived/unarchived.
+- State: A special kind of ongoing event that can be upserted (created or updated) repeatedly by a stable eventId, and resolved when finished.
+- Integration: Built-in webhook adapters that convert 3rd-party payloads (e.g. GitHub, Stripe, Sentry, Tencent Cloud Alarm) into Feed events.
+- Notification: Channels can fan-out events to configured notifiers; delivery frequency can be tuned by channel settings.
+
+## Typical use cases
+
+- Product and infra incident stream across multiple services
+- CI/CD deployment and release notices
+- Billing and subscription signals
+- Security, monitoring and error alerts

website/docs/feed/state.md

@@ -0,0 +1,41 @@
+---
+sidebar_position: 4
+---
+
+# State (ongoing incidents)
+
+Feed State models ongoing incidents with an immutable `eventId`. You can repeatedly upsert updates to the same `eventId` until it is resolved.
+
+## Endpoints
+
+- Upsert state (public): `POST /open/feed/{channelId}/state/upsert`
+- Resolve state (auth): `POST /open/workspace/{workspaceId}/feed/{channelId}/state/resolve`
+- List ongoing states (auth): `GET /open/workspace/{workspaceId}/feed/state/all?channelId=...&limit=...`
+
+## Upsert body
+
+```json
+{
+  "eventId": "deploy#2025-08-12",
+  "eventName": "deploy_progress",
+  "eventContent": "Rollout 60%",
+  "tags": ["prod"],
+  "source": "ci",
+  "senderId": "runner-42",
+  "senderName": "GitHub Actions",
+  "important": true,
+  "payload": {"stage": "canary"}
+}
+```
+
+If the channel is configured with `webhookSignature`, you must include header `x-webhook-signature`.
+
+## Resolve example
+
+```bash
+curl -X POST \
+  "$BASE_URL/workspace/$WORKSPACE_ID/feed/$CHANNEL_ID/state/resolve" \
+  -H "Authorization: Bearer $TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{"stateId": "STATE_ID"}'
+```