bazelbuild / bazelbuild/stardoc

Convenience rule for verifying checked-in documentation matches Stardoc output

Open
#16 0 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

We could probably leverage Stardoc's existing test-verification rules and provide users some convenience rules to help in managing checked-in Stardoc output.

Contributor guide

Open the contributing guide

Research direction

Start by examining Stardoc's existing test-verification rules and how they handle checked-in generated documentation. Determine the scope of the proposed convenience rules and consider the user workflow they should support; the work is done when checked-in Stardoc output can be conveniently verified against generated output.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.