bazelbuild / bazelbuild/stardoc

Stardoc for targets

Open
#108 3 comments 0 reactions 0 assignees View on GitHub
P4 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

Sometimes the target's name and rule kind don't provide much detail on its purpose. When should the target be used? Is it runnable, testable, or just buildable? Maybe it's meant only to be used as part of a larger dependency?

This kind of information along with details that come from the rule could be a good source of documentation for a package, especially for newcomers. Imagine looking through a BUILD.bazel file with a bunch of sh_binary() targets. This could seem very opaque without some context.

Contributor guide

Open the contributing guide

Research direction

No source file, test, or entry point is named. Start by reviewing how Stardoc currently documents rules and targets, then define which target-purpose and rule-derived details should appear in package documentation. Done means generated documentation makes target usage and buildability clear, including for targets such as sh_binary().

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.