nim-works/nimskull

docgen for `threads` and `builtin_channels` links broken

Aberta

#1.466 aberto em 24 de out. de 2024

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Nim (39 forks)auto 404
bugdocumentationgood first issuehelp wanted

Métricas do repositório

Stars
 (346 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Threading and channels related documentation is now generated again, as part of https://github.com/nim-works/nimskull/pull/1464, but due to a docgen bug the documentation for the threads and builtin_channels modules, which are included from the system module do not work.

This used to work with the legacy docgen feature, but that has since been removed, see: https://github.com/nim-works/nimskull/pull/303. Update the existing docgen to get the links working again from the generated index.html.

Guia do colaborador

Direção de pesquisa
Examine o código docgen que gera links para módulos incluídos e corrija os links quebrados para threads e builtin channels.
Pilha de tecnologia
None
Domain
documentationbackend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitNim
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45