From 6c02facd595b3dfc075ea617406b882ab6e71169 Mon Sep 17 00:00:00 2001 From: "songshiyu.11" Date: Wed, 12 Aug 2026 20:11:21 +0800 Subject: [PATCH] docs: finalize developer preview documentation --- CHANGELOG.md | 12 ++++++++---- CONTRIBUTING.md | 10 +++++++++- README.md | 25 +++++++++++++++++++++++-- README.zh.md | 19 +++++++++++++++++-- SECURITY.md | 2 +- docs/release.md | 22 ++++++++++++++++++++++ docs/release.zh.md | 20 ++++++++++++++++++++ 7 files changed, 100 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02a56c6..46c4883 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,16 +5,20 @@ All notable changes to Nexus will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Added +- English and Chinese interface preview screenshots for the public README + +### Changed +- Clarified preview installation, MCP setup, supported platforms, and known limits + ## [0.1.0-preview.1] - 2026-08-12 ### Added - Apple Silicon Developer Preview DMG with a real `Nexus.app` bundle - Bundled Node.js 26.5.0 Runtime and MCP Helper with first-launch installation - Stable MCP shim, runtime diagnostics, and reproducible package verification - -## [Unreleased] - -### Added - Native SwiftUI Mac app with menu-bar entry and quick switching - Work creation, editing, archive, restore, and delete flows - Local file and pasted text materials with per-material assistant visibility diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c3a431..68c27eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Nexus -Nexus is a pre-alpha macOS developer tool. Small, focused contributions are easier to review and less likely to disturb the trust boundary around local context. +Nexus is a validation-focused macOS Developer Preview. Small, focused contributions are easier to review and less likely to disturb the trust boundary around local context. This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. @@ -13,3 +13,11 @@ This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT. 5. Run the checks in the [development guide](docs/development.md). Issues and pull requests are welcome. For security-sensitive reports, use GitHub private reporting rather than a public issue. + +## Project Status + +The current public artifact is intended for local evaluation and dogfooding. +Feature development may pause between validation rounds, so not every feature +request will immediately become part of the next release. Reproducible bugs, +focused documentation fixes, and changes that preserve the local-first trust +boundary are the most useful contributions during this stage. diff --git a/README.md b/README.md index 6612dec..6788f73 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ macOS 14 or later

-> **Status:** pre-alpha Apple Silicon Developer Preview. The preview DMG includes a private Node.js Runtime and MCP Helper. It is not Developer ID signed or notarized. +> **Status:** `v0.1.0-preview.1` Apple Silicon Developer Preview. The preview DMG includes a private Node.js Runtime and MCP Helper. It is not Developer ID signed or notarized. Nexus helps a coding assistant understand **what you are working on, which materials are authoritative, what remains uncertain, and what changed in the code workspace**. @@ -45,6 +45,25 @@ Nexus does not replace your coding assistant. The assistant explores and edits c Model output is always a draft. It changes the context exposed through MCP only after explicit user approval. +## Current Status + +The latest public artifact is `v0.1.0-preview.1`. This is a validation-focused +Developer Preview for local dogfooding, not a production release. Feature +development may pause between validation rounds while the core workflow is +being evaluated; focused bug reports, documentation fixes, and reproducible +feedback are still welcome. + +Current preview limitations: + +- Apple Silicon only, with macOS 14 or later; +- the app is not Developer ID signed or notarized; +- model preparation requires your own OpenAI or DeepSeek API key and does not + reuse a ChatGPT or coding-assistant login; +- material preparation is explicit and text-focused; PDF, Word, deep web + capture, and whole-repository indexing are not included; +- Nexus does not automatically switch branches, merge, push, run agents, or + synchronize data to a team service. + ## Why Nexus Opening another assistant conversation preserves chat history, but it does not reliably preserve: @@ -82,7 +101,9 @@ Requirements: - macOS 14 or later; - no separate Node.js installation is required. -The preview is unsigned and notarized neither by Developer ID nor by the Mac App Store. macOS may require the usual local-preview confirmation when opening it for the first time. +The preview is not signed with Developer ID and is not notarized by Apple. macOS +may require the usual local-preview confirmation when opening it for the first +time. ## Try It diff --git a/README.zh.md b/README.zh.md index d15cc8f..a70170d 100644 --- a/README.zh.md +++ b/README.zh.md @@ -23,7 +23,7 @@ macOS 14 或更高版本

-> **当前状态：** pre-alpha Apple Silicon Developer Preview。预览版 DMG 已包含私有 Node.js Runtime 和 MCP Helper，但暂未进行 Developer ID 签名和公证。 +> **当前状态：** `v0.1.0-preview.1` Apple Silicon Developer Preview。预览版 DMG 已包含私有 Node.js Runtime 和 MCP Helper，但暂未进行 Developer ID 签名和公证。 Nexus 帮助编码助手理解：**你正在做什么、哪些材料是依据、哪些内容仍不确定，以及代码工作区发生了什么变化**。 @@ -45,6 +45,20 @@ Nexus 不替代编码助手。助手负责探索和修改代码；Nexus 负责 模型输出始终是草稿。只有用户明确采用后，Context Pack 才会成为当前 Work 的上下文并通过 MCP 暴露。 +## 当前状态 + +最新公开构建为 `v0.1.0-preview.1`。这是用于本地体验和真实工作验证的 +Developer Preview，不是生产发行版。核心流程验证期间，功能开发可能在不同 +轮次之间暂时放缓；欢迎提交聚焦的 Bug、文档修正和可复现的使用反馈。 + +当前预览版的限制： + +- 仅支持 Apple Silicon，系统要求 macOS 14 或更高版本； +- App 暂未进行 Developer ID 签名和公证； +- 整理功能需要用户自己的 OpenAI 或 DeepSeek API Key，不会复用 ChatGPT 或编码助手登录状态； +- 材料整理需要用户明确选择，当前以文本材料为主，暂不包含 PDF、Word、深度网页采集和全仓库索引； +- Nexus 不会自动切换分支、合并、推送、运行 Agent，也不会自动同步到团队服务。 + ## Nexus 解决什么问题 多开一个助手对话可以保存聊天记录，但不能可靠回答： @@ -84,7 +98,8 @@ Nexus 不会自动切换、stash、reset、提交、合并、推送或删除用 - macOS 14 或更高版本； - 普通使用不需要单独安装 Node.js。 -当前预览版未进行 Developer ID 签名、公证或 Mac App Store 发布。首次打开时，macOS 可能会要求按系统提示确认运行本地预览应用。 +当前预览版未进行 Developer ID 签名、公证或 Mac App Store 发布。首次打开时，macOS +可能会要求按系统提示确认运行本地预览应用。 ## 快速体验 diff --git a/SECURITY.md b/SECURITY.md index 511b825..0f06f16 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Supported Versions -Nexus is a pre-alpha project. Security fixes are made against the latest commit on `main`. +Nexus is a Developer Preview. Security fixes are made against the latest commit on `main`. ## Reporting a Vulnerability diff --git a/docs/release.md b/docs/release.md index 843100b..41b00c6 100644 --- a/docs/release.md +++ b/docs/release.md @@ -6,6 +6,28 @@ The current preview targets Apple Silicon Macs running macOS 14 or later. The DM The preview is not Developer ID signed or notarized. It is intended for local evaluation and dogfooding, not unattended enterprise deployment. +## Published Preview + +The current public release is +[`v0.1.0-preview.1`](https://github.com/NoraSoong/Nexus/releases/tag/v0.1.0-preview.1). +Download the Apple Silicon DMG from the release page and verify it with the +included `SHA256SUMS` asset before opening it. + +## Install and Connect + +1. Open the DMG and drag `Nexus.app` to `Applications`. +2. Launch Nexus once. The app installs its bundled Helper into the app-managed + Application Support directory and creates the stable MCP command. +3. Open Assistant Connection in Nexus and use the displayed configuration for + the MCP client you use. +4. Keep Nexus running in the menu bar while an assistant needs to read context; + pausing assistant access or quitting the app intentionally stops context + exposure. + +The app can be removed from `Applications` without deleting local Work data. +Do not remove the Nexus Application Support directory unless you also intend +to remove local context data and installed Helper versions. + ## Build locally ```bash diff --git a/docs/release.zh.md b/docs/release.zh.md index 49f1953..08fc2c8 100644 --- a/docs/release.zh.md +++ b/docs/release.zh.md @@ -6,6 +6,26 @@ 预览版暂未进行 Developer ID 签名和公证，适合本地体验与 dogfooding，不适合作为无人值守的企业部署包。 +## 已发布预览版 + +当前公开版本为 +[`v0.1.0-preview.1`](https://github.com/NoraSoong/Nexus/releases/tag/v0.1.0-preview.1)。 +请从 Release 页面下载 Apple Silicon DMG，并在打开前使用其中的 +`SHA256SUMS` 文件校验下载结果。 + +## 安装与连接 + +1. 打开 DMG，将 `Nexus.app` 拖入 `Applications`。 +2. 首次启动 Nexus。App 会把内置 Helper 安装到自己管理的 Application Support + 目录，并创建稳定的 MCP 命令路径。 +3. 在 Nexus 的 Assistant Connection 中查看并复制你所使用 MCP 客户端的配置。 +4. 当助手需要读取上下文时，让 Nexus 保持在菜单栏运行；暂停助手读取或退出 App + 会按设计停止上下文暴露。 + +可以直接从 `Applications` 移除 App，不会自动删除本地 Work 数据。除非你也希望 +删除本地上下文数据和已安装的 Helper 版本，否则不要手动删除 Nexus 的 +Application Support 目录。 + ## 本地构建 ```bash