docs(docs): link repository files from /docs now that the repository is public

オープン 初心者向け
  • 何か問題がありますか？
#462 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
nextjs, playwright, react, typescript
領域
documentation, frontend

調査の方向性

src/components/docs/doc-markdown.tsx:216 から始め、次に src/lib/docs.ts:290 と src/lib/docs.test.ts:210 のアサーションを確認してください。現時点では各コメントが、パスと issue 参照をプレーンテキストとしてレンダリングする理由にプライベートリポジトリを挙げています。まず3つの箇所をまとめて読み、issue が求めているケースごとの判断を確定してから、コード、コメント、テストの理由をそろえて更新してください。src/lib/docs.test.ts を実行し、レンダリングされた出力が変わる場合は Playwright で e2e/docs.spec.ts を更新してください。完了とは、どのコメントもテストもプライバシーを理由に挙げておらず、すべてのファイル参照が GitHub へリンクするか現在の理由を示している状態です。

索引モデルが issue の本文から書いたものです。

説明

area: docs documentation priority: P3 size: S

Context

The repository went public on 2026-11-15. Three places still rely on it being private, found in the #457 review:

  • src/components/docs/doc-markdown.tsx:216: "The repository is private, so a path is shown, never linked."
  • src/lib/docs.ts:290: a repository file "renders as text, not a link".
  • src/lib/docs.test.ts:210: "publishes no issue references" gives the private repository as its reason.

Plan

  1. Decide per case whether /docs should now link repository files and issues on GitHub, or keep rendering them as text for another reason.
  2. Update the code, the comments, and the tests to match.

Acceptance criteria

  • No comment or test reason says the repository is private.
  • Repository file references in /docs either link to the file on GitHub or say why they do not.
  • Playwright e2e: e2e/docs.spec.ts updated if links change.

Files and areas

src/components/docs/doc-markdown.tsx, src/lib/docs.ts, src/lib/docs.test.ts. Non-goals: the docs content itself.

Model: anthropic/claude-opus-5-5 | Reasoning effort: unknown

主要言語
TypeScript
スター
1
フォーク
1
平均マージ
6時間 56分
マージ済み PR（30日）
136

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

eddiejaoude/StackDash のほかの issue

eddiejaoude/StackDash の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。