Skip to content

docs: 修复LICENSE链接并补充最小使用示例 - #1

Open
evan188199-tech wants to merge 1 commit into
marginnoteapp:mainfrom
evan188199-tech:codex/docs-license-minimal-example
Open

docs: 修复LICENSE链接并补充最小使用示例#1
evan188199-tech wants to merge 1 commit into
marginnoteapp:mainfrom
evan188199-tech:codex/docs-license-minimal-example

Conversation

@evan188199-tech

Copy link
Copy Markdown

问题

README 中的 LICENSE 链接指向维护者本机路径 /Users/shenshichao/Downloads/mnutils_v0_2_2_alpha0228/LICENSE,其他用户克隆仓库后无法打开。现有文档也缺少一个组合 Runtime、MNNote 和 MNConnection 的最小使用示例。

最小复现

克隆仓库后在 GitHub 或本地 Markdown 预览中点击 README 末尾的 LICENSE 链接,链接目标不存在于仓库内。

改动边界

  • 将 LICENSE 链接改为仓库相对链接。
  • 增加一个最小 Add-on 流程示例,展示 Runtime.registerLifecycleRuntime.registerRouteMNNote.newMNConnection.fetchDev
  • 仅修改 README,不改变运行时代码、manifest、版本号或格式风格。

验证

  • git diff --check:PASS
  • git diff --name-only:PASS,仅包含 README.md
  • 确认示例中的 API 均对应现有源码实现:Runtime.registerLifecycleRuntime.registerRouteMNNote.newMNConnection.fetchDevMNUtil.showHUD:PASS

兼容性

纯文档变更,不影响运行时行为和打包产物。当前 GitHub Release 仍标记为 prerelease;本 PR 不调整 README 的 Stable 状态标识。

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