registrystack / registrystack/registry-stack

Take reference/breg-api and reference/breg-configuration out of draft

Open
#940 0 comments 0 reactions 0 assignees View on GitHub
agent-ready area:breg area:docs criticality:p3 documentation triage:needs-implementation
Dominant language
Rust
Stars
2
Forks
0
Avg merge
2h 55m
Merged PRs (30d)
130

Description

Found in the 0.28.0 pre-release review (2026-09-08). Line references are as of main after #926.

Both pages are `status: draft`, `last_reviewed: unreviewed`, with 12 and 7 inbound links from current pages. `breg-configuration.mdx` is generated from schema descriptions; most properties added since v0.27.0 carry no `description` on their schemars types and render as blank rows, and `actions[].requires[].equals` never renders because its subschema is the bare boolean `true` (`registry-project.schema.json:502`), which `docs/site/scripts/configuration-reference.mjs:306` drops.

Proposed: add `description` to the schemars types, teach the walker to render boolean subschemas, then review both pages and set their review record.

Contributor guide

Open the contributing guide

Research direction

Start by reading docs/site/scripts/configuration-reference.mjs around line 306 and inspecting registry-project.schema.json:502, then trace the schemars types that supply the configuration descriptions. Done means the blank properties and actions[].requires[].equals render correctly, both reference/breg-api and reference/breg-configuration are reviewed, and their review records no longer show as unreviewed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rust
Domain
backend-api-design, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.