Skip to content

docs(guide): 帮助用户开始使用 InKCre - #31

Merged
xiaoland merged 22 commits into
mainfrom
docs/user-guide-information-architecture
Sep 23, 2026
Merged

xiaoland merged 22 commits into
mainfrom
docs/user-guide-information-architecture

Conversation

@xiaoland

@xiaoland xiaoland commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

目标

帮助已经理解 InKCre 基本理念、但尚无实例的用户完成一个真实闭环:部署自己的实例,通过 Web 连接,选择一个 Source 并准备对应 Extension,收集第一项信息,再把它找回来和用于自己连接的工具。

用户指南

  • 将 Getting Started 组织为 User Guide 内唯一的线性旅程:连接 Web、选择 Source、准备对应 Extension、首次采集、找回真实信息。
  • 将后续内容按 Collection、Organization、Application / Use、Self-Hosted 组织;采集调度与搜索索引维护分开,CLI/Agent 和 ChatGPT MCP 归入 Use。
  • 为 RSS、GitHub、Mail、Telegram、Twitter、Memos 提供独立教程;Web 是用户默认界面,CLI 是 Agent 的补充接口。
  • 随 client-web#118 的新流程,统一 Web 教程为跳转 Registry 浏览并选择精确版本、回到 Web 确认安装、再从已安装 Extension 的「Enable…」弹窗多选 Peer 启用;停用同样在「Disable…」弹窗选择目标 Peer;不再指导用户使用已移除的 Discover/Installed 内部视图。
  • 为 Render + Neon、Heroku + Neon 和自选基础设施提供 step-by-step 自部署路径;Self-Hosted 首页只负责选择路径,不再维护第二套 Getting Started。
  • 增加生态开发者的 Source Extension 指南,并记录 Registry 托管的精确 Release / 渠道文档入口。

产品表达与首页

  • 将产品主张收敛为:从用户已有工具收集信息,让用户和自己连接的工具可以找到并使用;Organization 只在有帮助时改善信息。
  • 修正 Collection 与 Organization 的边界;首页、Getting Started 和 About 不再要求读者先理解 info-base、Blocks、Relations 或 Peer。
  • 将首页改造成 landing page,以“让保存的信息真正可用”为主张,用来源 → 自己的实例 → 使用场景解释一个完整信息闭环。
  • 复用 InKCre 既有品牌图形与视觉语言:中性黑白灰、直角、细边界、平面层次和局部等宽;不增加前端依赖或新的设计框架。
  • 全站精简重复前言、装饰标题、无依赖的 Next 和重复上手路径,并在既有 website README 中沉淀页面职责、标题、步骤归属及渲染复核标准。

验证

  • pnpm --dir website check
  • git diff --check
  • 桌面与 390px 窄屏、浅色与深色首页实看
  • Web 教程截图按桌面浅色、1:1 / 4:3 / 近 16:9 标准复核
  • 精确 PR head 的 Website contract 与 Cloudflare Pages preview

协同交付

Registry #56 提供版本页回跳链接;client-web #118 提供确认安装。Web 已消费正式 @inkcre/ui-web@2.1.1 并通过 CI;在线 Core 的启用、停用已在 owner Heroku/Neon 部署验收。Registry #56 的独立 Web 预览已部署,但目录为空;从版本页实际点击回跳仍单独跟踪。

Core #110 提供 Heroku 自部署和相关 Core 能力。跨仓库依赖只记录在 PR 中,面向用户的教程不包含临时“等待 PR 合并”提示。本 PR 保持 Draft,未授权合并。

@xiaoland

xiaoland commented Sep 21, 2026 •

Copy link
Copy Markdown
Member Author

PR #31 当前 head 5215f53 的预览已通过:

@xiaoland xiaoland changed the title docs(guide): 收敛用户入门信息架构 docs(guide): 帮助用户开始使用 InKCre Sep 22, 2026
@xiaoland

Copy link
Copy Markdown
Member Author

第四组界面同步已推送(b39a833):更新连接、扩展版本管理、任务观察与 RSS 步骤,并更新 Settings、新增 Type 下拉框的 1280×720 浅色桌面配图。网站完整 check、Website contract 与预览均通过,已在预览复核 RSS 教程图片。预览:https://preview-docs-pr-31.inkcre-website.pages.dev 。本 PR 继续保持 Draft,不合并。

@xiaoland
xiaoland marked this pull request as ready for review September 23, 2026 14:25
@xiaoland
xiaoland merged commit 03d0c54 into main Sep 23, 2026
3 checks passed
@xiaoland

Copy link
Copy Markdown
Member Author

最终交付:本 PR 已随 client-web#118、ext-reg#56 合并。文档 main 为 03d0c54,生产发布全部通过:https://github.com/InKCre/docs/actions/runs/35881210739 。已浏览器复核正式 https://inkcre.dev/guide/connect 的连接步骤与更新后的 Settings/Peers 内容。原始截图、worktree 和本地任务材料保留;没有为收尾额外删除用户数据。

This branch was successfully deployed

1 active deployment
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