A Box Could Show Which Phase an Item Is In, From Phases Named in the Front Matter

Open
#220 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
javascript, markdown, yaml
Domain
tooling

Research direction

The issue names no files or tests. Start by reading how the existing staged-box syntax and its front matter (multibox, stages) are parsed and rendered in the repository. Nothing here is ready to build: the issue is posted for discussion and asks four open design questions. Done means a maintainer has answered them and the syntax is settled, not that code is merged.

Written by the indexing model from the issue text.

Description

enhancement team-attention

Reviews now track each item through three phases, Heard, Agreed and Done. Staged boxes can already do that:

---
multibox:
  stages: heard, agreed, done
---

- [x][ ][ ] Rename the setting
- [x][x][ ] Drop the old flag
- [x][x][x] Fix the tried Try's label

Each click fills the next box, and the stage reached shows beside it. What's written is a count, though: [x][x][ ] has to be read as "the second stage" and looked up in the front matter, and an item can only go forward one stage at a time.

The idea

Give each phase a key, and let one box hold the key of the phase it's in:

---
phases:
  - Heard, h
  - Agreed, a
  - Done, d
---

- [h] Rename the setting
- [a] Drop the old flag
- [d] Fix the tried Try's label
  • - [a] reads as "agreed" in the source, and is shorter than [x][x][ ].
  • reader shows the phase's name beside the box, as it does a stage's.
  • Elsewhere, GitHub shows [h] as text, where [x][ ][ ] shows as text too, so neither is worse there.

Questions

  • Is this worth a second syntax, next to staged boxes, or should staged boxes write the stage's key instead ([x][x][ ] → [a])?
  • Does a click step through the phases in order, as a staged box does, or pick one?
  • Do [x] and [ ] still mean done and not started, alongside the keys?
  • Should progress:[] count an item as done only at the last phase?

Came up in the 2026-11-01 retro. It isn't yet clear it's worth it; this is for discussion.

Dominant language
JavaScript
Stars
0
Forks
1
Avg merge
2d 4h
Merged PRs (30d)
26

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jzheaux/reader

All issues in jzheaux/reader

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.