bazelbuild / bazelbuild/stardoc

Improve documentation for utility functions available to custom templates

Open
#39 1 comment 0 reactions 0 assignees View on GitHub
P4 type: bug
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

Right now, the documentation links to a raw java file, which is intimidating. We should make it clear that users are encouraged to use the available utility functions, and we should make it more obvious what functions are available.

Contributor guide

Open the contributing guide

Research direction

Locate the documentation page that currently links to the raw Java file, then inspect the referenced utility functions and how custom templates use them. Done means the docs explain that these utilities are encouraged and clearly identify the available functions without requiring users to start from a raw source file.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.