Fix documentation typos and broken links
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 90/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- markdown, typescript
调研方向
该 issue 列出了需要编辑的特定文件：docs/pelican-terminal-gap-research.md、packages/coding-agent/docs/rpc.md、SECURITY.md、packages/providers/src/api/openai-completions.ts 和 packages/coding-agent/src/core/compaction/compaction.ts。首先在代码仓库中找到这些文件。对于每个文件，进行指定的修正：更新或移除损坏的链接、修正文件路径并纠正拼写错误。通过本地检查修改后的文件来验证更改。当所有列出的问题都已解决且未引入新错误时，即告完成。
由索引模型根据 Issue 内容生成。
描述
A docs and comments review found several problems that can confuse readers or point them to missing files:
docs/pelican-terminal-gap-research.mdlinks to four comparison screenshots underpixel-art/pelican-terminal-gap-research/, but those files are not present in the repository.packages/coding-agent/docs/rpc.mdpoints topackages/agent/src/types.ts, although the current source ispackages/agent-core/src/types.ts.- There are typos in
SECURITY.md(Isuses, “non trustworthy”),packages/providers/src/api/openai-completions.ts(knwo), andpackages/coding-agent/src/core/compaction/compaction.ts(settions).
Please update or remove the dead screenshot references, point the RPC guide to the current source path, and correct the spelling errors. A local audit checked 97 Markdown files and found no other broken relative links after these changes.
- 主要语言
- TypeScript
- 星标
- 1k
- 派生
- 65
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 70
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
stepfun-ai/Step-Code 的其他 Issue
-
area/build bug
难度 2/5 1-3 小时 新手友好度 75/100
stepfun-ai/Step-Code#190 · 2 条评论 ·
维护者通常 1 天内回复
-
area/tools bug
难度 2/5 1-3 小时 新手友好度 75/100
stepfun-ai/Step-Code#184 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
stepfun-ai/Step-Code#179 · 1 条评论 ·
维护者通常 1 天内回复
-
untriaged
难度 2/5 1-3 小时 新手友好度 75/100
stepfun-ai/Step-Code#151 · 1 条评论 ·
维护者通常 1 天内回复
-
untriaged
难度 2/5 1-3 小时 新手友好度 75/100
stepfun-ai/Step-Code#149 · 2 条评论 ·
维护者通常 1 天内回复
查看 stepfun-ai/Step-Code 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 74/100
paperclipai/paperclip#17151 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 83/100
AgoraIO-Extensions/agent-infra#3159 ·
维护者通常 1 天内回复
-
blocklist addition
难度 1/5 1 小时以内 新手友好度 66/100
MetaMask/eth-phishing-detect#304596 ·
维护者通常 1 天内回复
-
friction
难度 2/5 1-3 小时 新手友好度 70/100
kentcdodds/kody#4142 ·
-
[Bug] Statistics | Task statistics are always empty on MikroORM with MySQL or SQLite可能已有人在做 @NdekoCode 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 76/100
ever-co/ever-gauzy#11214 ·
维护者通常 1 天内回复