Come up with plan for API documentation tooling
Aberta
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C++
- Estrelas
- 74
- Forks
- 9
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
We depend on documentation 4.0.0 as more recent releases removed polygot - refs documentationjs/documentation#850.
We either need to:
- Switch to a different tool
- Fix our usage of documentationjs to keep working with more recent versions
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando a dependência atual de documentation 4.0.0 e a issue #850 referenciada do documentationjs sobre o recurso polygot removido. Compare os dois caminhos propostos — trocar de ferramenta ou corrigir o uso para releases mais recentes — e defina a conclusão como uma configuração de documentação de API documentada e funcional.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- cpp, node.js
- Domínio
- api, documentation, tooling
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100