Fix documentation typos and broken links
まだ誰も着手していません。
評価
- 難易度
- 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
- スター
- 54
- フォーク
- 20
- 平均マージ
- 4時間 1分
- マージ済み PR(30日)
- 12
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stepfun-ai/Step-Code のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stepfun-ai/Step-Code#190 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stepfun-ai/Step-Code#186 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stepfun-ai/Step-Code#185 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stepfun-ai/Step-Code#184 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stepfun-ai/Step-Code#179 · コメント 1 件 ·
stepfun-ai/Step-Code の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
receptron/mulmoterminal#2264 ·
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
components-web-app/docs#96 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
simonsobs/tileviewer#114 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100