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

Improve autogenerated SDK documentation

Cerrado
#36 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza inspeccionando la documentación generada en crossplane.github.io/function-sdk-python/function.html y la salida de documentación generada a partir de protobuf del Python SDK. Revisa cómo se genera actualmente la documentación, incluido si ya se utiliza Sphinx o MkDocs. Se considerará completado cuando la documentación tenga una página de inicio útil, versionado y cobertura del código generado a partir de protobuf, y el enfoque requiera poco mantenimiento.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation enhancement
What problem are you facing?

We have autogenerated SDK documentation at https://crossplane.github.io/function-sdk-python/function.html, but it's not great.

Some things that could be improved:

  • There's no versioning - the generated docs always and only reflect the main branch.
  • The landing page is empty.
  • There's no documentation for the protobuf generated code.

Documentation for the protobuf generated code seems like it would be very valuable, since there's not much else to this SDK apart from a few utilities. Unfortunately the code itself doesn't seem to have docstrings, despite the protobuf messages it's generated from having them.

How could this Function help solve your problem?
  • Figure out if there's some way to copy docstrings from the protobuf schema to the generated code.
  • Use a better docs tool (Sphinx, mkdocs, etc). Ideally something low maintenance.
Lenguaje dominante
Python
Estrellas
12
Forks
15
Merge medio
1 d 12 h
PR fusionados (30 d)
7

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 crossplane/function-sdk-python

Todos los issues de crossplane/function-sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.