[Docs]: ROADMAP test counts and controls list are out of date
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- documentation
Research direction
Open docs/ROADMAP.md and compare the Current State test counts and Controls summary with the verified counts and Phase 3 note in the issue. Update the counts to models 4, highlighter 13, renderer 18, app 2, and 9 doctests; remove the tab-width selector from the existing controls list. Done when both sections match the described code and UI.
Written by the indexing model from the issue text.
Description
What happened?
docs/ROADMAP.md contains a stale test inventory and a stale controls list.
Details
-
The test counts in the Current State section (
docs/ROADMAP.md:74-76) say: models 4, highlighter 7, renderer 15, app 2, plus 6 doctests. Verified actual numbers: models 4, highlighter 13, renderer 18, app 2, plus 9 doctests. -
The Controls summary (around
docs/ROADMAP.md:68-71) lists a "tab-width selector" as an existing control, but Phase 3 of the same document (around line 270) records that the tab-width control was prototyped and reverted on purpose. The control does not exist in the UI.
Expected behavior
The document matches the code, per the documentation-first workflow.
Where did it go wrong?
Not applicable (documentation)
Settings
Not applicable.
Browser
Not applicable.
CodeFrame version
0.7.0
Console output or extra context
Verification commands:
cargo test --lib # 35 tests: models 4, highlighter 13, renderer 18
cargo test --doc # 9 doctests: highlighter 5, renderer 4
- Dominant language
- Rust
- Stars
- 1
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 5
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from suradet-ps/codeframe
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
suradet-ps/codeframe#40 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
suradet-ps/codeframe#35 ·
Maintainers usually reply within 1 day
-
[Bug]: Target width input clamps the value on every keystrokePossibly taken @AnushreeKasturi claimed this 1 day ago. Openbug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
suradet-ps/codeframe#37 · 2 comments ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
suradet-ps/codeframe#38 ·
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
suradet-ps/codeframe#30 ·
Maintainers usually reply within 1 day
All issues in suradet-ps/codeframe
Similar issues
-
area:ecosystem documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Chelis-Lang/chelis#3866 ·
Maintainers usually reply within 1 day
-
bug documentation sev-0
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
dekobon/big-code-analysis#1620 ·
Maintainers usually reply within 3 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100