Skip to content

docs: installation.md sits in the EN slot in Japanese and contradicts the JA file #255

Description

@liplus-lin-lay

目的

docs/installation.md が英語版のスロットに置かれながら中身が日本語であり、さらに docs/installation.ja.md事実が食い違っている。両方を解消する。

観測(v0.12.0 の wiki 同期作業中に検出)

本 issue は今回の移行が原因ではない。既存の状態。

1. 言語スロットの不一致

  • docs/_Sidebar.md:4Installation: [[EN|installation]] / [[JA|installation.ja]] と宣言している
  • 実際の docs/installation.md は冒頭から日本語(# インストール / ## クイックスタート
  • 同じ repo の docs/0-requirements.md は英語(# github-webhook-mcp Requirements Specification)であり、規約は守られている。installation だけが外れている
  • 姉妹リポジトリ Liplus-Project/github-rag-mcp の docs/installation.md# github-rag-mcp Installation Guide / Language: English | [Japanese](installation.ja.md) で正しい形

結果として、wiki の EN リンクを踏んだ利用者に日本語ページが出る。

2. 2 ファイル間の事実の矛盾(言語問題より重い)

単なる翻訳漏れではなく、内容が乖離している。差分 10 行のうち事実に関わるもの:

箇所 installation.md installation.ja.md
L55 ダウンロード対象 mcp-server.mcpb github-webhook-mcp.mcpb
L274 channel の経路 WebSocket 経由 SSE 経由
L288 疎通テスト wscat -c wss://<worker>/events(SSE 併記) curl -N https://<worker>/events のみ
L79-82 alwaysLoad の説明 英語のまま残存 日本語

どちらが現行の実装と一致しているかは未確認。mcp-server/package.jsonws を依存に持ち、/events は SSE として叩ける記述もあるため、両方が存在するのか片方が陳腐化しているのかを実装で確かめる必要がある

配布ファイル名の食い違いも、利用者が存在しないファイルを探す形になるため実害がある。

制約

  • どちらが正しいかを実装で確認してから直すこと。 片方をもう片方に揃えるだけでは、誤っているほうへ揃える可能性がある
  • docs/ は source of truth であり wiki へミラーされる。修正はリリース時に自動で wiki へ流れる
  • 言語規約は docs/0-requirements.md / .ja.md の対が正しい形。installation もそれに揃える

対象ファイル

  • docs/installation.md — 英語版として書き直す
  • docs/installation.ja.md — 事実の食い違いを解消した側に揃える
  • 必要なら mcp-server/README.md(同じ記述を持つ場合)

関連

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsdocumentation changereadybody converged for implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions