nim-works/nimskull

docgen for `threads` and `builtin_channels` links broken

Open

#1,466 opened on Oct 24, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Nim (39 forks)auto 404
bugdocumentationgood first issuehelp wanted

Repository metrics

Stars
 (346 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Examine the docgen code that generates links for included modules and fix the broken links for threads and builtin channels.
Tech stack
None
Domain
documentationbackend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNim
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45