Repository navigation
docs(readme): face rooms, presence/mentions, accurate Bot Social setup - #308
Conversation
…Bot Social setup Refresh EN/ZH README from shipped docs: face-to-face join (6-digit), Sharing grants, Auto-send, thinking presence; keep Timeline optional/off by default. Reuse docs/images/demo-social.mp4; add demo-face.png still. Example server URL in Quick Start. Intent-based plain-line routing is not documented as a product feature.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dc8f92679c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **Members.** Access is a per-Bot **grant** (default deny, Chief included). A local Bot becomes `@<bot>.<home>` on the server when you invite someone to that Bot, when it joins an invite, or when you bring it into a face-to-face room. The sidebar lists only Bots granted to you. **Manage access** on a Bot shows who has it and **Revoke**. Deleted Bots are revoked. Ungranted Bots have no outside identity: friends cannot reach them and they cannot message friends. | ||
| - **Friends in the Bot list.** A friend's Bot sits in the same sidebar list as yours, with a small globe after the name. Face-to-face rooms sit there too, with a people mark; ended ones fold under **Past rooms**. Click a row to open a normal chat. Right-click a local Bot → **Copy invite link** (or **Copy invite with instructions**), or use the sidebar **+** → **Add friend** to paste a friend's link and join. **Face-to-face group**, **Copy invite link**, and **Copy my handle** are on the same **+** menu. **Auto-send** for a friend is on that Bot's settings. | ||
| - **Approvals.** Inbound messages from a friend arrive immediately. Outbound replies may wait in the open chat (badge + Approve / Reject) until you decide, unless Auto-send is on for that friend. FlyBot also holds a Bot's own send behind an approval card; files are always held. | ||
| - **Friends in the Bot list.** A friend's Bot sits in the same sidebar list as yours, with a small globe after the name. Face-to-face rooms sit there too, with a people mark; ended ones fold under **Past rooms**. Click a row to open a normal chat. Sidebar **+** → **Add friend** (paste a handle, invite link or code), **Face-to-face group**, and **Copy my handle**. On a local Bot: right-click / settings **Sharing** → **Invite to this Bot** (or **Copy invite link** / **Copy with instructions**); **People with access** lists who has it and **Revoke**. **Auto-send** for a friend is on that friend's Bot settings (default off). |
There was a problem hiding this comment.
The Add friend form does not resolve a handle: it sends the entered value to social/join-invite, whose handler only strips an /i/ URL into an invite code and passes it to join_invite (plugins/social/src/social.js:1537-1558). Entering the newly advertised @name.home handle therefore treats it as a code and fails; document only invite links/codes unless handle lookup is implemented.
Useful? React with 👍 / 👎.
| - **Friends in the Bot list.** A friend's Bot sits in the same sidebar list as yours, with a small globe after the name. Face-to-face rooms sit there too, with a people mark; ended ones fold under **Past rooms**. Click a row to open a normal chat. Sidebar **+** → **Add friend** (paste a handle, invite link or code), **Face-to-face group**, and **Copy my handle**. On a local Bot: right-click / settings **Sharing** → **Invite to this Bot** (or **Copy invite link** / **Copy with instructions**); **People with access** lists who has it and **Revoke**. **Auto-send** for a friend is on that friend's Bot settings (default off). | ||
| - **Face-to-face rooms.** Sidebar **+** → **Face-to-face group**: pick one or more of your Bots, enter the **same 6-digit number** as your friend (about 10 minutes), wait, then **Enter chat** (or **Leave**). No prior friendship and no preview of the other home's other Bots. Your typed lines are sent as you (when the server supports `typed_by_owner`); `@Name` / the picker label / a handle asks that Bot; `@all` asks everyone. Bot-written room lines still go through Approve unless face **Auto-send** is on (open room overview; default off). | ||
| - **Typed by the owner · mentions · thinking.** Against a Bot Social that lists these under `GET /v1/platform` `features`: your typed friend-DM and face lines can be stamped `typed_by_owner` so the other home draws them as you; face sends may carry an explicit `mentions` handle list; a quiet `Name is thinking…` line appears above the composer while a friend's Bot works (ephemeral `presence`). Older servers simply omit what they do not support. | ||
| - **Approvals.** Inbound messages from a friend arrive immediately (fenced as untrusted). Outbound replies may wait in the open chat (badge + Approve / Reject) until you decide, unless Auto-send is on for that friend or face room. FlyBot also holds a Bot's own send behind an approval card; files are always held. |
There was a problem hiding this comment.
When a user enables the checkbox from one room overview, the plugin persists the owner-wide auto_approve_face_rooms setting (plugins/social/src/social.js:345-351), not a setting for that room. Describing approval as bypassed when Auto-send is on “for ... [a] face room” can make users believe other concurrent or future rooms remain approval-gated, although their Bot-written messages will also be sent automatically; describe the face setting as global.
Useful? React with 👍 / 👎.
Refresh README (EN + ZH) against current main (~5257129 / social features through #301).
What changed
typed_by_owner/mentions/presence(“Name is thinking…”) — only when the Bot Social server advertises them.cordis.patch.ymlserver+displayName→ restart → onboard → credentials path; invites; face join). Notes that Bot Social’s Grok/setupsentence is a different client path.docs/images/demo-face.png.ARCH_DOCS_BASE=origin/main TZ=UTC npm run verifygreen.