Skip to content

refactor(www): 修改文档站-入门模块#403

Merged
Nomikfk1215 merged 1 commit into
1024XEngineer:mainfrom
Nomikfk1215:codex/www-getting-started-clean
May 7, 2026
Merged

refactor(www): 修改文档站-入门模块#403
Nomikfk1215 merged 1 commit into
1024XEngineer:mainfrom
Nomikfk1215:codex/www-getting-started-clean

Conversation

@Nomikfk1215

Copy link
Copy Markdown
Collaborator

No description provided.

@codecov

codecov Bot commented May 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fennoai fennoai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewed the changed docs/theme code across code quality, performance, security, and documentation-accuracy passes. The new tabs component builds cleanly; the remaining concerns are both in the onboarding docs, where the rewrite now steers beginners toward persisting raw API keys without the warnings or env-var alternative used elsewhere in the docs.

Comment thread www/zh/quick-start.md
:::warning 安全提示
不要把含有真实 `api_key` 的配置文件提交到 Git。建议把 `.bytemind/` 加入 `.gitignore`,或者改用 `api_key_env` 字段读取环境变量。
:::
将其中的 `YOUR_API_KEY` 替换为你的真实 API Key。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Medium: this rewrite removed the previous secret-handling warning, but it still tells new users to put a raw provider.api_key into ~/.bytemind/config.json. A few lines later the page also mentions project-level .bytemind/config.json, so this is now much more likely to end up committed by mistake. Please either restore the api_key_env / .gitignore warning here or switch the quick-start sample to the env-var form.

Comment thread www/zh/api-key.md

## 第四步:写入 ByteMind 配置

把下面的 `YOUR_DEEPSEEK_API_KEY` 替换为你刚复制的 Key。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Medium: this new page makes plaintext provider.api_key the only documented setup path, which conflicts with the existing guidance in provider-setup / FAQ to prefer api_key_env. Because this page is now the entry point for first-time provider setup, it will nudge users toward storing secrets on disk and copying them into repo-local overrides. At minimum, add the same warning and env-var alternative here.

@Nomikfk1215 Nomikfk1215 merged commit b47bf40 into 1024XEngineer:main May 7, 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.

1 participant