From ce2e711789fcfe4a83f829dff67a181f7535dd25 Mon Sep 17 00:00:00 2001 From: Freecode100Year <174155046+Freecode100Year@users.noreply.github.com> Date: Sat, 7 Nov 2026 22:46:47 -0500 Subject: [PATCH 1/2] docs: rewrite bilingual VIVANT README --- README.en.md | 106 +++++------------- README.md | 106 +++++------------- .../plans/2026-11-07-readme-rewrite.md | 39 +++++++ .../specs/2026-11-07-readme-rewrite-design.md | 24 ++++ 4 files changed, 123 insertions(+), 152 deletions(-) create mode 100644 docs/superpowers/plans/2026-11-07-readme-rewrite.md create mode 100644 docs/superpowers/specs/2026-11-07-readme-rewrite-design.md diff --git a/README.en.md b/README.en.md index 57b6558..9836f78 100644 --- a/README.en.md +++ b/README.en.md @@ -1,103 +1,57 @@ -# VIVANT · Anonymous terminal chat room +# VIVANT · Anonymous terminal chat [简体中文](README.md) | English [![CI](https://github.com/Freecode100Year/vivant/actions/workflows/ci.yml/badge.svg)](https://github.com/Freecode100Year/vivant/actions/workflows/ci.yml) -One SSH command and you're in the chat room. No sign-up, no password, no app. +Join an open chat room over SSH. No account, password, or app required. -``` +```sh ssh -p 2222 guest@term.freedom8964.com ``` -``` - VIVANT Alice · 在线 Online 3 · 运行 Up 4d 12h · 18:34 CST -房间 ROOMS ▸#general 3 #chinese 0 +2 #english 0 #technology 0 #anonymous 0 -[18:32] 大家晚上好！ -[18:33] Hello from New York! -[18:33] 有人在学编程吗？@Alice -[18:34] [私信 DM ← Ghost] hi -── #general · 3 人在线 here · 大厅 · Lobby · 什么都可以聊 ───────────────────────── -> 说点什么… Type a message… /help 帮助 help -Enter 发送 send · ↑↓ 历史 history · PgUp/PgDn 滚动 scroll · Ctrl+C 退出 quit ● 已连接 CONNECTED -``` - -Every prompt, the help and the key hints are shown in both Simplified Chinese and English. - -## How to connect +On your first connection, check that the SSH host fingerprint matches: -**Computer** (Windows, macOS and Linux all ship ssh): run the command above. On first connect SSH asks whether to trust the server; type `yes`. - -**iPhone / iPad**: - -- **iSH Shell**: free on the App Store. Run `apk add openssh-client` once, then the command above. -- **Termius**: add a host with address `term.freedom8964.com`, port `2222`, username `guest`, password empty. +```text +SHA256:WsbkUnVIJ9KcrMBltrWHTxyZemKMaJv3tTvZJCOPhHE +``` -If your network only lets port 443 through, use `-p 443` instead of `-p 2222` (the operator has to enable it). Any username works and there is no password. If the screen is too narrow or shows garbage, use the username `plain` for line mode. More ways to connect (Tor, scripts, skipping the fingerprint prompt): [Connecting and using](docs/usage.en.md). To connect an AI agent: [AI agents](docs/agents.en.md). +## Inside the chat -## Everyday commands +- Type to talk. Use `/rooms` to see channels and `/join english` to switch rooms. +- Send a private message with `/msg `, or change your nickname with `/nick `. +- Menus, prompts, and help are shown in both Simplified Chinese and English. Type `/help` for commands. +- Choose an eye-friendly green, black, or white terminal theme. If your terminal has display issues, use the `plain` username for text mode. +- AI agents can connect through SSH in JSON mode; see [AI agents](docs/agents.en.md). -Just type to talk. - -``` -/rooms list rooms -/join english join a room -/msg private message -/nick change your nickname -/who who is here -/help all every command -``` +On a computer, run the command above. For iPhone and iPad setup, Tor, and script usage, see [Connecting and using](docs/usage.en.md). If your network only allows TCP 443, you can use `-p 443` only when the operator has enabled the alternate port. ## Privacy -- No accounts; your SSH public key is never sent to the server; no IPs, nicknames or messages in the logs; messages live in memory only and expire. -- **The server can read the chat.** Don't post anything that identifies you. In the chat, `/privacy` shows what this server keeps and doesn't, and `/forget` erases your messages. -- To hide your IP from the server too: connect over Tor (if the operator enabled it). +- No account is needed, and the server does not receive ordinary users' SSH public keys. +- **The server can read chat messages. SSH is not end-to-end encryption.** Don't share information that identifies you. +- By default, room history stays in memory only, up to 500 messages per room for up to 24 hours; a server restart clears it. Operators can change these settings. Private messages are not stored. Use `/privacy` to see this server's settings and `/forget` to remove your messages from room history. +- The program does not log IP addresses, nicknames, or chat messages. Connecting over Tor hides your real IP from the server; connecting through an `.onion` address requires Tor to be enabled by the operator. -Details: [Security and anonymity](docs/security.en.md). +See [Security and anonymity](docs/security.en.md) for more about the limits and implementation. -## Run your own +## Host your own -On a Linux VPS: +Install on a Linux VPS with one command: -```bash +```sh curl -fsSL https://raw.githubusercontent.com/Freecode100Year/vivant/main/install.sh | sudo bash ``` -Manage it with `sudo vivant-ctl status | upgrade | uninstall`. If people can't connect, run `sudo vivant-ctl doctor`: it checks everything and tells you how to fix it. Remember to allow TCP 2222 in your cloud provider's firewall, and on Cloudflare set the DNS record to DNS only (grey cloud). Docker works too, see [Deployment and configuration](docs/deploy.en.md#docker-optional). - -**Server can't reach GitHub:** download the offline one-click installer from the release page and run `bash vivant--linux-offline.sh --to root@SERVER` on your computer, see [Offline install](docs/deploy.en.md#offline-install-server-cant-reach-github). For a temporary server on Windows / macOS (testing, LAN), the release page has those binaries too, see [Deployment and configuration](docs/deploy.en.md#windows--macos). - -**Upgrading from Private-Talk Terminal:** VIVANT used to be called Private-Talk Terminal (`ptterm`). Run the command above once on the old server and it migrates automatically, keeping the host key, configuration, bans and onion address. See [Deployment and configuration](docs/deploy.en.md#migrating-from-private-talk-terminal). - -A 1-core, 1 GB VPS handles about 2000 people online at once. Installer options, admins and settings: [Deployment and configuration](docs/deploy.en.md). - -## Plan - -Improvements chosen after studying similar projects (ssh-chat, devzat, SoftRoom, sshoosh, SSHChat), done in order. Rule: nothing new for newcomers to learn, nothing that weakens anonymity. - -- [x] **Colour-blind and low-vision friendly colours**: black text on eye-care green by default, `/theme` switches to black or white; every colour meets WCAG AAA (7:1+) on all three; messages mentioning you are an orange band, `@nick` is underlined -- [x] **Bell on mentions and private messages**: on by default, `/bell off` to disable (from devzat) -- [x] **Collapse join/leave lines in busy rooms**: "3 joined, 2 left" (from ssh-chat `/quiet`) -- [x] **Alternate port 443**: `--alt-port 443` at install, for users behind strict firewalls (from devzat) -- [x] **Host fingerprint check, `ssh chat` shortcut**: documented; `vivant-ctl status` prints the fingerprint (from ssh-chat, devzat) -- [x] **Tor exits share the generous Tor limits**: Tor Browser users aren't capped per address (the reverse of devzat, which blocks Tor) -- [x] **Bilingual interface**: every prompt, `/help`, key hints and installer output in Simplified Chinese and English -- [x] **`vivant-ctl doctor`**: checks service, ports, firewall, DNS, Cloudflare grey cloud (from sshoosh) -- [x] **Optional hardening**: per-connection read throttle, Docker image (from ssh-chat, sshoosh) -- [x] **Handshake timeout**: connections that don't enter the chat within 30 s are closed, so scanners can't hold slots; installer and `doctor` warn about well-known ports like 443 -- [x] **External monitoring, passphrase design rule**: documented (from devzat, ssh-chat, sshoosh) -- [x] **Hardening after a security review**: modern SSH algorithms only, invisible and tag characters stripped (with a fuzz test), global TCP cap, fresh ban key when no ban is active -- [x] **Renamed to VIVANT**: old servers migrate by running the installer -- [x] **Offline one-click install**: one self-extracting file, `--to root@SERVER` deploys straight from your computer; plus Windows / macOS binaries for testing and LANs +For Docker, offline installs, configuration, and administration, see [Deployment and configuration](docs/deploy.en.md). ## Documentation -- [Connecting and using](docs/usage.en.md): every platform, iPhone step by step, all commands, Tor -- [AI agents](docs/agents.en.md): `bot@` JSON mode, example program -- [Security and anonymity](docs/security.en.md): what the operator can see and what can't be promised -- [Deployment and configuration](docs/deploy.en.md): installer options, migration, admins, settings, Docker -- [Performance](docs/performance.en.md): load tests and design -- [Development](docs/development.en.md): build, test, release, code layout, roadmap +- [Connecting and using](docs/usage.en.md) +- [AI agents](docs/agents.en.md) +- [Security and anonymity](docs/security.en.md) +- [Deployment and configuration](docs/deploy.en.md) +- [Performance and capacity](docs/performance.en.md) +- [Development, build, and release](docs/development.en.md) -Written in Rust, one static binary, no database, MIT licensed. +VIVANT is written in Rust and released under the MIT license. diff --git a/README.md b/README.md index 90ccc54..d299ed1 100644 --- a/README.md +++ b/README.md @@ -4,100 +4,54 @@ [![CI](https://github.com/Freecode100Year/vivant/actions/workflows/ci.yml/badge.svg)](https://github.com/Freecode100Year/vivant/actions/workflows/ci.yml) -一条 SSH 命令进入聊天室。不用注册、不用密码、不用装 App。 +用 SSH 进入一个开放的聊天室：不用注册、没有密码，也不需要安装 App。 -``` +```sh ssh -p 2222 guest@term.freedom8964.com ``` -``` - VIVANT Alice · 在线 Online 3 · 运行 Up 4d 12h · 18:34 CST -房间 ROOMS ▸#general 3 #chinese 0 +2 #english 0 #technology 0 #anonymous 0 -[18:32] 大家晚上好！ -[18:33] Hello from New York! -[18:33] 有人在学编程吗？@Alice -[18:34] [私信 DM ← Ghost] hi -── #general · 3 人在线 here · 大厅 · Lobby · 什么都可以聊 ───────────────────────── -> 说点什么… Type a message… /help 帮助 help -Enter 发送 send · ↑↓ 历史 history · PgUp/PgDn 滚动 scroll · Ctrl+C 退出 quit ● 已连接 CONNECTED -``` - -所有提示、帮助和按键说明都同时显示简体中文和英文。 - -## 怎么连 +第一次连接时，请核对 SSH 显示的主机指纹： -**电脑**（Windows / macOS / Linux 自带 ssh）：运行上面那条命令。第一次连接会问是否信任服务器，输入 `yes`。 - -**iPhone / iPad**： +```text +SHA256:WsbkUnVIJ9KcrMBltrWHTxyZemKMaJv3tTvZJCOPhHE +``` -- **iSH Shell**：App Store 免费下载，先运行 `apk add openssh-client`，再运行上面的命令。 -- **Termius**：新建主机，地址 `term.freedom8964.com`，端口 `2222`，用户名 `guest`，密码留空。 +## 聊天室里有什么 -网络只放行 443 时，把 `-p 2222` 换成 `-p 443`（需部署者开启）。用户名随便填，没有密码。屏幕太窄或显示乱码时，把用户名换成 `plain`，进入纯文本模式。更多连接方式（Tor、脚本、免确认指纹）见[连接与使用](docs/usage.md)；接入 AI 智能体见 [AI 智能体接入](docs/agents.md)。 +- 直接打字发言；用 `/rooms` 查看频道，`/join chinese` 切换频道。 +- 用 `/msg <昵称> <内容>` 私聊，或用 `/nick <名字>` 改昵称。 +- 所有菜单、提示和帮助都同时显示简体中文与英文；输入 `/help` 查看命令。 +- 终端界面支持护眼绿、黑、白主题；终端不兼容时，用户名换成 `plain` 可用纯文本模式。 +- AI 智能体可以通过 SSH 的 JSON 模式接入，见 [AI 智能体接入](docs/agents.md)。 -## 常用命令 +电脑运行上面的命令即可。iPhone / iPad 的 iSH、Termius 等连接步骤，以及 Tor 和脚本用法，见[连接与使用](docs/usage.md)。如果你的网络只放行 TCP 443，只有在部署者开启备用端口后才能改用 `-p 443`。 -直接打字就是发言。 +## 隐私说明 -``` -/rooms 有哪些房间 -/join chinese 进入房间 -/msg <昵称> <内容> 私聊 -/nick <名字> 改昵称 -/who 谁在这里 -/help all 全部命令 -``` +- 不需要账号；普通用户的 SSH 公钥不会发送给服务器。 +- **服务器能读取聊天内容。SSH 不是端到端加密。** 不要发送能识别你身份的信息。 +- 默认情况下，房间消息记录只在内存里保留（每个房间最多 500 条、最长 24 小时），服务器重启后清空；私聊不保存。部署者可以修改房间记录设置。输入 `/privacy` 查看当前服务器的数据设置，输入 `/forget` 删除自己发过的房间消息。 +- 程序日志不记录 IP、昵称或聊天内容。通过 Tor 连接可以隐藏真实 IP；使用 `.onion` 地址则需要部署者开启 Tor。 -## 隐私 +更多边界与实现细节见[安全与匿名性](docs/security.md)。 -- 没有账号；你的 SSH 公钥不会发给服务器；日志里没有 IP、昵称和聊天内容；消息只在内存里，过期自动删除。 -- **服务器能看到聊天内容**，别发能认出你的信息。在聊天室里输入 `/privacy` 可以查看这台服务器存什么、不存什么，`/forget` 删除你发过的消息。 -- 想连 IP 也不让服务器看到：通过 Tor 连接（需要部署者开启）。 +## 自建聊天室 -详细说明见[安全与匿名性](docs/security.md)。 +在 Linux VPS 上运行一条命令即可安装： -## 部署自己的聊天室 - -在一台 Linux VPS 上运行： - -```bash +```sh curl -fsSL https://raw.githubusercontent.com/Freecode100Year/vivant/main/install.sh | sudo bash ``` -装好后用 `sudo vivant-ctl status | upgrade | uninstall` 管理；连不上时运行 `sudo vivant-ctl doctor`，它会逐项检查并告诉你怎么修。别忘了在云厂商的防火墙里放行 TCP 2222；域名在 Cloudflare 上要设为 DNS only（灰云）。也可以用 Docker 部署，见[部署与配置](docs/deploy.md#docker可选)。 - -**服务器连不上 GitHub：** 下载发布页里的离线一键安装包，在自己电脑上运行 `bash vivant-<版本>-linux-offline.sh --to root@服务器` 即可部署，见[离线安装](docs/deploy.md#离线安装服务器连不上-github)。想在 Windows / macOS 上临时跑一个（测试、局域网），发布页也有对应的程序，见[部署与配置](docs/deploy.md#windows--macos)。 - -**从 Private-Talk Terminal 升级：** VIVANT 以前叫 Private-Talk Terminal（`ptterm`）。在旧服务器上运行一次上面的命令即可自动迁移，主机密钥、配置、封禁、洋葱地址都会保留，详见[部署与配置](docs/deploy.md#从-private-talk-terminal-迁移)。 - -单核 1GB 的 VPS 大约能承载 2000 人同时在线。安装参数、管理员、配置项见[部署与配置](docs/deploy.md)。 - -## 计划 - -参考同类项目（ssh-chat、devzat、SoftRoom、sshoosh、SSHChat）后定下的改进，按顺序进行。原则：不增加新用户要学的东西，不削弱匿名。 - -- [x] **色盲、视力差友好的配色**：默认护眼绿背景、黑色文字，`/theme` 可换黑、白；三种背景下所有文字对比度都达到 WCAG AAA（7:1 以上）；@你 的消息是橙色高亮条，`@昵称` 加下划线 -- [x] **被 @、收到私聊时响铃**：默认开启，`/bell off` 关闭（借鉴 devzat） -- [x] **人多时折叠进出提示**：合并成“3 人进入、2 人离开”（借鉴 ssh-chat `/quiet`） -- [x] **备用 443 端口**：安装时加 `--alt-port 443`，给被防火墙拦住的用户一条路（借鉴 devzat） -- [x] **核对主机指纹、`ssh chat` 短命令**：写进文档，`vivant-ctl status` 显示指纹（借鉴 ssh-chat、devzat） -- [x] **Tor 出口 IP 共用宽松限额**：避免误伤用 Tor 浏览器直连的人（反向借鉴 devzat，它拒绝 Tor 用户） -- [x] **界面中英双语**：所有提示、`/help`、按键说明、安装脚本输出同时标注简体中文和英文 -- [x] **`vivant-ctl doctor` 自检**：逐项检查服务、端口、防火墙、域名解析、Cloudflare 灰云（借鉴 sshoosh） -- [x] **可选加固**：连接层读取限速、Docker 镜像（借鉴 ssh-chat、sshoosh） -- [x] **握手超时**：30 秒内没进入聊天的连接直接断开，扫描器占不住名额；443 等知名端口在安装和 `doctor` 时给出提醒 -- [x] **外部监控、口令设计原则**：写进文档（借鉴 devzat、ssh-chat、sshoosh） -- [x] **安全审计后的加固**：只用现代 SSH 算法、剔除隐形字符和标签字符（附模糊测试）、TCP 总连接上限、没有生效封禁时自动换封禁密钥 -- [x] **改名 VIVANT**：旧服务器运行一键安装命令自动迁移 -- [x] **离线一键安装**：一个自解压文件，`--to root@服务器` 从自己电脑直接部署；另附 Windows / macOS 程序供测试和局域网使用 +Docker、离线安装、配置和管理方式见[部署与配置](docs/deploy.md)。 ## 文档 -- [连接与使用](docs/usage.md)：各平台连接方法、iPhone 详细步骤、全部命令、Tor -- [AI 智能体接入](docs/agents.md)：`bot@` JSON 模式、示例程序 -- [安全与匿名性](docs/security.md)：部署者能看到什么、不能保证什么 -- [部署与配置](docs/deploy.md)：一键安装参数、迁移、管理员、配置项、Docker -- [性能](docs/performance.md)：压测数据和设计 -- [开发](docs/development.md)：构建、测试、发布、代码结构、路线图 +- [连接与使用](docs/usage.md) +- [AI 智能体接入](docs/agents.md) +- [安全与匿名性](docs/security.md) +- [部署与配置](docs/deploy.md) +- [性能与容量](docs/performance.md) +- [开发、构建与发布](docs/development.md) -Rust 编写，单个静态二进制，无数据库，MIT 许可。 +VIVANT 使用 Rust 编写，以 MIT 许可证发布。 diff --git a/docs/superpowers/plans/2026-11-07-readme-rewrite.md b/docs/superpowers/plans/2026-11-07-readme-rewrite.md new file mode 100644 index 0000000..6c91967 --- /dev/null +++ b/docs/superpowers/plans/2026-11-07-readme-rewrite.md @@ -0,0 +1,39 @@ +# README Rewrite Implementation Plan + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. + +**Goal:** Rewrite both GitHub READMEs to invite users into VIVANT first and present self-hosting as a clear secondary path. + +**Architecture:** Documentation-only change. Keep the Chinese and English files parallel in structure; source feature and privacy claims from existing docs. + +**Tech Stack:** Markdown. + +**Spec:** `docs/superpowers/specs/2026-11-07-readme-rewrite-design.md` + +## Global Constraints + +- Preserve valid repository and documentation links. +- Keep the stated privacy boundary explicit: the server can read chat messages. +- Do not change code or other product documentation. + +## Review Focus + +- Chinese and English versions describe the same join, privacy, and self-hosting paths. +- Public connection command and deployment links remain valid. +- No completed roadmap checklist or unsupported claims remain. + +--- + +### Task 1: Rewrite the bilingual GitHub README + +**Files:** +- Modify: `README.md` +- Modify: `README.en.md` + +**Interfaces:** +- Consumes: Existing usage, security, agent, and deployment documentation. +- Produces: Parallel, join-first READMEs with a concise product introduction, SSH quick start, feature summary, explicit privacy boundary, secondary self-hosting entry, and documentation links. + +- [ ] Rewrite `README.md` and `README.en.md` in matching order; retain the supported public SSH endpoint and existing docs links, remove the completed plan list, and keep deployment details in the deployment guide. +- [ ] Review `git diff --check`, compare section structure between languages, and verify each README link target exists. +- [ ] Commit the reviewed documentation changes on the feature branch; do not publish them to the shared repository yet. diff --git a/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md b/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md new file mode 100644 index 0000000..e457ef8 --- /dev/null +++ b/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md @@ -0,0 +1,24 @@ +# README Rewrite Design + +## Intent + +Rewrite the Chinese and English GitHub READMEs to help prospective visitors join the public chat quickly, while keeping self-hosting easy to discover. + +## Goals and non-goals + +- Lead with the chat's purpose and a copyable SSH command. +- Summarize features and privacy accurately, including that the server can read messages. +- Keep self-hosting as a secondary path and link to the existing deployment guide. +- Keep `README.md` and `README.en.md` aligned in structure and meaning. +- Do not change code or other product documentation. + +## Approaches + +- Join-first README with concise feature/privacy sections and a self-hosting link (chosen; best matches the public project's immediate user action). +- Self-host-first installation guide (rejected; deployment details already have a dedicated guide). + +## Constraints + +- Preserve valid repository/document links and supported SSH commands. +- Remove the completed plan checklist instead of adding a new roadmap. +- Do not introduce unsupported privacy, performance, or feature claims. From c5b6c4306982dcc0b84e48549de8da31c990c85b Mon Sep 17 00:00:00 2001 From: Freecode100Year <174155046+Freecode100Year@users.noreply.github.com> Date: Sat, 7 Nov 2026 22:58:32 -0500 Subject: [PATCH 2/2] chore: keep planning notes out of README PR --- .../plans/2026-11-07-readme-rewrite.md | 39 ------------------- .../specs/2026-11-07-readme-rewrite-design.md | 24 ------------ 2 files changed, 63 deletions(-) delete mode 100644 docs/superpowers/plans/2026-11-07-readme-rewrite.md delete mode 100644 docs/superpowers/specs/2026-11-07-readme-rewrite-design.md diff --git a/docs/superpowers/plans/2026-11-07-readme-rewrite.md b/docs/superpowers/plans/2026-11-07-readme-rewrite.md deleted file mode 100644 index 6c91967..0000000 --- a/docs/superpowers/plans/2026-11-07-readme-rewrite.md +++ /dev/null @@ -1,39 +0,0 @@ -# README Rewrite Implementation Plan - -> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. - -**Goal:** Rewrite both GitHub READMEs to invite users into VIVANT first and present self-hosting as a clear secondary path. - -**Architecture:** Documentation-only change. Keep the Chinese and English files parallel in structure; source feature and privacy claims from existing docs. - -**Tech Stack:** Markdown. - -**Spec:** `docs/superpowers/specs/2026-11-07-readme-rewrite-design.md` - -## Global Constraints - -- Preserve valid repository and documentation links. -- Keep the stated privacy boundary explicit: the server can read chat messages. -- Do not change code or other product documentation. - -## Review Focus - -- Chinese and English versions describe the same join, privacy, and self-hosting paths. -- Public connection command and deployment links remain valid. -- No completed roadmap checklist or unsupported claims remain. - ---- - -### Task 1: Rewrite the bilingual GitHub README - -**Files:** -- Modify: `README.md` -- Modify: `README.en.md` - -**Interfaces:** -- Consumes: Existing usage, security, agent, and deployment documentation. -- Produces: Parallel, join-first READMEs with a concise product introduction, SSH quick start, feature summary, explicit privacy boundary, secondary self-hosting entry, and documentation links. - -- [ ] Rewrite `README.md` and `README.en.md` in matching order; retain the supported public SSH endpoint and existing docs links, remove the completed plan list, and keep deployment details in the deployment guide. -- [ ] Review `git diff --check`, compare section structure between languages, and verify each README link target exists. -- [ ] Commit the reviewed documentation changes on the feature branch; do not publish them to the shared repository yet. diff --git a/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md b/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md deleted file mode 100644 index e457ef8..0000000 --- a/docs/superpowers/specs/2026-11-07-readme-rewrite-design.md +++ /dev/null @@ -1,24 +0,0 @@ -# README Rewrite Design - -## Intent - -Rewrite the Chinese and English GitHub READMEs to help prospective visitors join the public chat quickly, while keeping self-hosting easy to discover. - -## Goals and non-goals - -- Lead with the chat's purpose and a copyable SSH command. -- Summarize features and privacy accurately, including that the server can read messages. -- Keep self-hosting as a secondary path and link to the existing deployment guide. -- Keep `README.md` and `README.en.md` aligned in structure and meaning. -- Do not change code or other product documentation. - -## Approaches - -- Join-first README with concise feature/privacy sections and a self-hosting link (chosen; best matches the public project's immediate user action). -- Self-host-first installation guide (rejected; deployment details already have a dedicated guide). - -## Constraints - -- Preserve valid repository/document links and supported SSH commands. -- Remove the completed plan checklist instead of adding a new roadmap. -- Do not introduce unsupported privacy, performance, or feature claims.