Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Adapt language ecosystem native API docs practices wherever possible

Abierto
#1,653 1 comentario 0 reacciones 1 asignado Ver en GitHub

@edburns ya está trabajando en esto.

Desde el 13/6/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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.

Lenguaje dominante
Java
Estrellas
10.5k
Forks
1.5k
Merge medio
1 d 9 h
PR fusionados (30 d)
130

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/copilot-sdk

Todos los issues de github/copilot-sdk

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.