bazelbuild / bazelbuild/stardoc

Support lists in Description column

Open
#78 1 comment 1 reaction 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 see needs for supporting bulleted or numbered lists format inside the Description cell in the table for our macro documents (would need an update of util.markdownCellFormat() function in Bazel which formats the cell so it's not possible to just update the template).
Sometimes we have a list och dictionaries or strings in the table (in one row) and need to have a description of each element inside one cell. It can be quite many elements so it gives quite much text and have needs to be structured in a way so the information will be clear. We also in the Description have a need to inform about default value of a specific dictionary/list (can't be informed in the Default column since that would be just [ ]). So all in all we think that lists would help us to structure the information so it gets more readable.

Contributor guide

Open the contributing guide

Research direction

Start by locating util.markdownCellFormat() in the Bazel documentation-generation code and inspect how the Description column currently formats text. Determine how bulleted and numbered lists should render inside a table cell, including descriptions of list or dictionary elements and their defaults; done means these cases produce readable structured output.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.