jaredly / jaredly/redoc

Don't build documentation for non-public directories

Open
#14 1 comment 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
JavaScript
Stars
114
Forks
11
PR merge metrics
No merged PRs in 30d

Description

I have a bunch of my modules in my bsb project that reside in directories marked not public in my bsconfig. Ideally these would not be documented either in the output of docre.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating how docre reads bsconfig and selects directories or modules for documentation. Check how the non-public setting is represented in a bsb project, then verify that those modules are excluded from generated output while public modules remain documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, ocaml
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.