Skip to content

docs(onboarding): 帮助用户开始使用 InKCre - #28

Open
xiaoland wants to merge 11 commits into
mainfrom
feat/user-getting-started
Open

xiaoland wants to merge 11 commits into
mainfrom
feat/user-getting-started

Conversation

@xiaoland

@xiaoland xiaoland commented Sep 20, 2026

Copy link
Copy Markdown
Member

目标与已提交内容

帮助初步了解InKCre理念、具备初级技术基础但尚无实例的用户开始收集、整理和使用信息。Web是用户默认界面,CLI是Agent/operator的补充接口。

  • 首页Getting Started介绍应用的What/Why/How;Self-hosting包含Getting Started和Advanced。Neon + Render/Heroku是fork快速部署,也说明数据库初始化、PostgREST和Python Core的手动部署路径。
  • 连接、Extension、采集、检索、调度和日常使用拆为复用页面;RSS/Atom、GitHub Stars/Lists、Mail、Telegram Bot inbox、Twitter bookmarks、Memos各有指南。Memos是兼容写入入口,不是拉取Source。
  • 同页Web / CLI·Agent切换,SPA跨页保持选择;ChatGPT MCP Sink + Secure MCP Tunnel归入Use Your Information;Source Extension生态开发指南与核心贡献分开。
  • 本切片移除必须由Agent安装Python包的前置步骤,改为Web选择在线Core安装,再逐Peer启用。Twitter指南使用0.4.0同版本双Host路径,不再建议为wizard降级;缺失MF时明确检查发布与Registry配置。
  • 为Cloudflare Pages preview增加精确PR head的docs preview状态,不改变生产部署路径。

验证

  • pnpm --dir website check:格式、生产构建和内部链接通过;git diff --check通过。
  • 既有浏览器验收覆盖Web默认、切换、跨页保持与排版;CLI命令、配置JSON和OAuth/Source示例离线检查通过。
  • 本切片联合Core/Web真实验收:Web连接隔离实例→选Core安装/启用RSS→创建Source→首次采集4篇→重复采集304→显式索引维护→Web检索命中已采集文章。索引维护仍需Agent/operator,不声称已有索引wizard。
  • Twitter0.4/Mail0.3公共Python产物与候选MF分别在Core/browser启用,Twitter Setup正常打开并显示Core callback;MF来自Toolkit本地preview,未连接真实X账号或邮箱。
  • ChatGPT教程以既有工具检索验收及官方文档为依据,不声称重新完成ChatGPT或Skill导入验收。

公开 MF 发行验收补充(2026-09-20)

  • 正式发布 run35508631514 attempt3与Web生产部署均成功。两个精确Release同时提供Python Host0.2与Web SDK0.2/0.3分发。
  • 线上Web与真实旧SDK0.2 Host均直接从公共Registry加载这两个MF,Twitter保存失败/重试、OAuth流程、Source/Cron/显式启动及Mail阅读/下载回放通过;外部账号接口使用隔离夹具。隔离真实Core与公共MF的同版本双端安装/启用也通过,显示真实Core callback,无真实X/邮箱账号操作。
  • Registry上传曾触发Heroku H12,但后台随后提交;先回读状态,再按同一run恢复,没有换版本、覆盖产物或部署Registry。公共完整snapshot、缓存/CORS/ETag及运行时行为均独立核对,不仅依赖工作流跳过已存在关联而变绿。
  • 独立重建的Twitter存在已核对的共享列表/remoteEntry映射排列差异,预加载索引解析到相同文件;不宣称恢复了CI原始产物或逐字节可复现。

协同交付与尚未实现

Core #110 提供Heroku和Core侧Web安装入口。client-web #104#107、兼容修正 #110Version #111 均已通过检查并合并,当前正式 Web 为5d488ce,包含#106。

合并/发布条件: Web及Twitter0.4/Mail0.3公共MF已正式发布;Core110与本PR仍保持独立、未合并,用户指南的整体交付仍须与Core安装入口协调。用户指南内不放临时PR待合并说明。

其他wizard及RSS可视化友好表单仍需先确认设计和验收方案,不能把本次文档更新或采集成功当成这些wizard已完成。UI和ext-reg无源码变更;没有修改共享Product/TDD合同或Spoke引用。

Preview与回滚

稳定入口:Docs PR28 preview。当前preview状态控制器尚在本PR,main的workflow_run仍不执行候选控制器;状态回填须先核对当前精确head部署成功。

网站变更可revert;各仓库发布各自负责。保持本PR现有ready状态,不在本轮合并。Web/MF已按用户单独授权完成正式发布;Core与Docs没有被连带合并。

@xiaoland
xiaoland marked this pull request as ready for review September 20, 2026 07:51
@xiaoland xiaoland changed the title docs(self-hosted): 增加面向用户的自部署入门指南 docs(onboarding): 帮助用户开始使用 InKCre Sep 20, 2026
- 提供 Neon + Render/Heroku 快速部署与手动部署路径
- 串联 CLI、信息源采集、索引检索和日常客户端使用
- 新增 Self-Hosted 导航与概览
- 在精确 PR head 上报告 pending、成功或错误状态
- 保留现有部署和清理流程,并说明 main 控制器生效边界
- 首页 Getting Started 介绍 What、Why、How 与实例访问路径
- Self-Hosted 下区分 Getting Started 和 Advanced
- 将手动部署迁至进阶指南并保留原入口跳转
- 自部署 Getting Started 仅编排阅读路径
- 独立提供连接、采集、检索、定时任务、来源、日常使用及排障指南
- Render 和 Heroku 部署分别成页,跨文档复用改用页面链接
- 覆盖 Sink 创建、凭据分离、tunnel 鉴权和 ChatGPT 连接
- 以真实工具检索作为验收点,说明 Skill 导入限制
- 增加停用步骤与常见故障排查
- 为 RSS、GitHub、邮件、Telegram、Twitter 和 Memos 提供独立上手路径
- 分离首次采集入口与共享 Job 操作,增加 Source Extension 构建及私有预览教程
- 核对发行版本并验证示例打包、授权请求和网站构建
- 补齐 Twitter setup wizard 与六种来源的可视化步骤
- 共享连接和扩展准备入口,修正浏览器自动注册说明
- 明确安装、索引维护及 Twitter 双端发行兼容边界
- 从来源指南移除必须委托 Agent 安装的前置步骤
- 明确 Core 选择、单独启用、版本保护与 Twitter 同版本向导
- 区分 global、Python 与 MF 文档集及第一方源所有权
- 约定精确版本发现、整包条件更新与独立快照隔离
- 保持 Release 安装协议、代码产物与文档纠错相互独立
@xiaoland
xiaoland force-pushed the feat/user-getting-started branch from e15a03f to fc8b255 Compare September 20, 2026 15:47
- 复用共享主题、界面切换和本地搜索\n- 显示精确发行版本与文档渠道,支持跨仓库构建
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant