Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Improve autogenerated SDK documentation

Fechada
#36 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
30/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Comece inspecionando a documentação gerada em crossplane.github.io/function-sdk-python/function.html e a saída da documentação gerada a partir de protobuf do Python SDK. Revise como a documentação atual é gerada, incluindo se Sphinx ou MkDocs já é usado. Considera-se concluído quando a documentação tiver uma página inicial útil, versionamento e cobertura do código gerado a partir de protobuf, e a abordagem exigir pouca manutenção.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.
Linguagem predominante
Python
Estrelas
12
Forks
15
Merge médio
1d 12h
PRs com merge (30d)
7

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de crossplane/function-sdk-python

Todas as issues de crossplane/function-sdk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.