Skip to content

re-readme美化#419

Merged
Nomikfk1215 merged 1 commit into1024XEngineer:mainfrom
voicepeak:re-readme
May 9, 2026
Merged

re-readme美化#419
Nomikfk1215 merged 1 commit into1024XEngineer:mainfrom
voicepeak:re-readme

Conversation

@voicepeak
Copy link
Copy Markdown
Collaborator

No description provided.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown

@fennoai fennoai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed the PR in four passes: code quality, performance, security, and documentation accuracy. The changed files are docs-only, and the only noteworthy issues are documentation mismatches with the current repository state.

Comment thread README.md Outdated

### Skills

Reusable workflows activated through slash commands.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README says these workflows are "activated through slash commands", but the current CLI only registers /help, /session, /sessions, /agents, /explorer, /review, /resume, /new, and /quit (internal/app/commands.go). ExecuteSlashCommand also has no routing for /bug-investigation, /repo-onboarding, /write-rfc, or /skill-creator (internal/app/slash_runtime.go), so this section overstates the command surface.

Comment thread README.zh-CN.md Outdated

### Skills

可通过斜杠命令激活的复用工作流。
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里写的是“可通过斜杠命令激活”,但当前 CLI 实际只注册了 /help/session/sessions/agents/explorer/review/resume/new/quit(见 internal/app/commands.go)。ExecuteSlashCommand 里也没有 /bug-investigation/repo-onboarding/write-rfc/skill-creator 的路由(见 internal/app/slash_runtime.go),所以这段会误导用户。

Comment thread README.md
go run ./cmd/bytemind chat
```
<p align="center">
<img src="./docs/assets/bytemind-terminal-preview.webp" alt="ByteMind terminal preview" width="960" />
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image path is broken in the current branch: ./docs/assets/bytemind-terminal-preview.webp does not exist, and docs/assets/ is absent. Merging this as-is will render a broken preview in the README.

Comment thread README.zh-CN.md
## 终端预览

<p align="center">
<img src="./docs/assets/bytemind-terminal-preview.webp" alt="ByteMind 终端运行截图" width="960" />
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个图片路径在当前分支是失效的:./docs/assets/bytemind-terminal-preview.webp 不存在,而且仓库里也没有 docs/assets/ 目录。合并后这里会直接显示为损坏图片。

@voicepeak
Copy link
Copy Markdown
Collaborator Author

@xgopilot 现在是否解决

@fennoai
Copy link
Copy Markdown

fennoai Bot commented May 9, 2026

结论

还没有全部解决。

已解决的问题:

  • README.md:156README.zh-CN.md:162 引用的 docs/assets/bytemind-terminal-preview.webp 现在已经存在,图片路径问题已修复。

仍未解决的问题:

  • README.md:346 仍然写着这些 Skills “activated through slash commands”,并列出了 /bug-investigation/repo-onboarding/write-rfc/skill-creator
  • README.zh-CN.md:352 也保留了同样的说法。
  • 但当前 CLI 实际只注册了 /help/session/sessions/agents/explorer/review/resume/new/quit,见 internal/app/commands.go:11-20
  • internal/app/slash_runtime.go:36-121 里也没有上述 4 个命令的执行分支。

如果你的目标是把之前指出的问题都关掉,这个 PR 还需要把这段文案改成与当前实现一致,或者先补齐这些 slash command 的实际支持。

View job run

@voicepeak
Copy link
Copy Markdown
Collaborator Author

@xgopilot 审查

@fennoai
Copy link
Copy Markdown

fennoai Bot commented May 9, 2026

Findings

  1. medium README.md:39, README.md:417
    英文 README 里的 DocumentationLinks 都指向了 https://1024xengineer.github.io/bytemind/zh/。但站点配置里英文是 root locale,中文才是 zh locale(www/.vitepress/config.mts:108-128)。这会把英文读者直接带到中文文档。

  2. medium README.md:156, README.zh-CN.md:162, docs/assets/bytemind-terminal-preview.webp
    这张新加的预览图虽然路径已存在,但文件内容不是 WebP:本地检查结果显示它是 JPEG image data,只是扩展名写成了 .webp。很多静态站点和 GitHub raw/CDN 会按扩展名发送 image/webp,这类 MIME/内容不匹配会导致图片继续无法渲染。

Notes

其余这次新增的命令、工具和配置字段说明,我按仓库实现逐项对过,没有再发现新的可确认不一致。

View job run

@Nomikfk1215 Nomikfk1215 merged commit 60e41c1 into 1024XEngineer:main May 9, 2026
6 checks passed
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.

2 participants