Adapt language ecosystem native API docs practices wherever possible
@edburns is already working on this.
Since Jun 13, 2026.
Assessment
This issue has not been assessed yet.
Description
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:
- https://javadoc.io/doc/com.github/copilot-sdk-java/latest/index.html
- https://github.github.com/copilot-sdk-java/1.0.1/apidocs/com.github.copilot.java/module-summary.html
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.
- Dominant language
- Java
- Stars
- 10.5k
- Forks
- 1.5k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 131
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/copilot-sdk
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2709 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
github/copilot-sdk#2673 ·
-
bug testing
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
github/copilot-sdk#2628 ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2627 · 1 comment ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
github/copilot-sdk#2493 ·
All issues in github/copilot-sdk
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cryptomator/hub#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
johanhaleby/occurrent#1120 ·