Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Adapt language ecosystem native API docs practices wherever possible

Aperta
#1,653 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

@edburns ci sta già lavorando.

Dal 13/6/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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.

Lingua principale
Java
Stelle
10.5k
Fork
1.5k
Merge medio
1g 9h
PR unite (30g)
130

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/copilot-sdk

Tutte le issue di github/copilot-sdk

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.