Adapt language ecosystem native API docs practices wherever possible

オープン

#1,653 2026年6月13日に作成コメント 1 件リアクション 0 件担当者 1 名 GitHub で見る

@edburns がすでに取り組んでいます。

2026年6月13日から。

評価

この issue はまだ評価されていません。

説明

documentation

Work items in this epic deal with bringing all supported languages to parity with Java regarding support for the expected practices for API docs in that language ecosystem.

For Java, we already have:

API Docs Ecosystem Summary

Ecosystem	Doc artifact required to publish?	Auto-hosted docs site	Culture strength
Java	✅ Yes (Maven Central mandate)	javadoc.io (3rd party)	Strong
Node/TS	❌ No	tsdocs.dev (3rd party, unreliable — see note below)	Moderate
Python	❌ No	Read the Docs (opt-in)	Strong convention
Go	❌ No (but comments are the format)	pkg.go.dev (1st party, automatic)	Very strong
.NET	❌ No (but XML doc conventionally included)	fuget.org (3rd party)	Strong
Rust	❌ No (but comments are the format)	docs.rs (1st party, automatic)	Very strong

Note on tsdocs.dev: As of 2026-06-13, tsdocs.dev returns 502 Bad Gateway across all URLs. It is a volunteer-run third-party project with no backing from npm or Microsoft and no SLA. It should not be relied upon as a primary docs hosting solution for @github/copilot-sdk. Self-hosted TypeDoc output (e.g. GitHub Pages from CI) is the only reliable option for TypeScript.

Bottom line: Go and Rust have the closest parity to Java's "publish once, docs appear everywhere" model — but achieved through first-party infrastructure rather than a mandated artifact. Python and .NET have strong doc cultures but require explicit hosting setup. TypeScript is the weakest — tsdocs.dev is unreliable (currently down), so self-hosted docs are a necessity.

主要言語: Java
スター: 10.5k
フォーク: 1.5k
平均マージ: 1日 9時間
マージ済み PR（30日）: 130

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

github/copilot-sdk のほかの issue

[aw] Issue Classification Agent timed out オープン

agentic-workflows

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

github/copilot-sdk#2760 · 2026年9月23日に作成
Python: shutdown notification rejects 'destroy' with SDK 1.0.14 / runtime 1.0.85 オープン

難易度 2/5 1〜3時間初心者へのやさしさ 65/100

github/copilot-sdk#2759 · 2026年9月23日に作成
docs/AGENTS.md is repo authoring guidance, but everything in docs/ gets published オープン

documentation

難易度 1/5 1時間未満初心者へのやさしさ 85/100

github/copilot-sdk#2758 · 2026年9月23日に作成
[aw] Issue Classification Agent timed out オープン

agentic-workflows

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

github/copilot-sdk#2709 · コメント 1 件 · 2026年9月17日に作成
_connect_via_tcp notification handler reads self._sessions without _sessions_lock オープン

難易度 1/5 1時間未満初心者へのやさしさ 78/100

github/copilot-sdk#2673 · 2026年9月15日に作成

github/copilot-sdk の issue をすべて見る

似ている issue

[Bug]: JavaScript dialog is complaining about changes when there were none オープン

awaiting triage bug Causes friction Hop Gui P1 P2 Transforms

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

apache/hop#8564 · 2026年9月23日に作成
[Bug][api] MemoryRef equality ignores the memory type オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

apache/flink-agents#1152 · 2026年9月23日に作成
Gauntlet loot not showing up in boss section オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

TheStonedTurtle/Loot-Logger#97 · 2026年9月23日に作成
TryBlueOceanMenu allocates a per-FlowNode URL object trio, retaining ~21 GiB on large pipeline graphs オープン

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

jenkinsci/blueocean-plugin#5417 · 2026年9月23日に作成
Dijkstra entry point crashes with ArrayIndexOutOfBoundsException when a vertex id exceeds the argument count オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

objectionary/eo-graphs#75 · 2026年9月23日に作成

Java の issue をもっと見る