Add Todo.md improvement tracker #17
Loading…
Reference in a new issue
No description provided.
Delete branch "chore/add-todo-file"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Adds
Todo.md— a future-improvements tracker started by Marvin8 — to the repository as-is. No other changes.WuMing
Found 6 issue(s). See inline comments below.
@ -0,0 +1,7 @@- Download full text of articles- Download image / images for all articles- Make images at least twice as wide, basically use more of the horizontal space withing the card, horizontal space can be adjusted as well.docs [LOW]
Typo: 'withing' should be 'within'.
docs [MEDIUM]
This bullet is a run-on and the phrase 'horizontal space can be adjusted as well' is vague. Rewrite for clarity, e.g., 'Make images at least twice as wide to use more horizontal space within the card; consider making the horizontal space configurable.'
@ -0,0 +1,7 @@- Download full text of articles- Download image / images for all articles- Make images at least twice as wide, basically use more of the horizontal space withing the card, horizontal space can be adjusted as well.- order articles in a group by article creation/upate datetime so that newst articles in a group / aggregate are always at the topdocs [LOW]
Typos: 'upate' should be 'update' and 'newst' should be 'newest'.
@ -0,0 +2,4 @@- Download image / images for all articles- Make images at least twice as wide, basically use more of the horizontal space withing the card, horizontal space can be adjusted as well.- order articles in a group by article creation/upate datetime so that newst articles in a group / aggregate are always at the top- implement configurable "ignore" rules. i.e. I am totally unintersted in any type of sports and don't want to see groups / articles about sports!docs [LOW]
Typo: 'unintersted' should be 'uninterested'. Also, 'i.e.' means 'that is'; use 'e.g.' when giving an example such as sports.
@ -0,0 +3,4 @@- Make images at least twice as wide, basically use more of the horizontal space withing the card, horizontal space can be adjusted as well.- order articles in a group by article creation/upate datetime so that newst articles in a group / aggregate are always at the top- implement configurable "ignore" rules. i.e. I am totally unintersted in any type of sports and don't want to see groups / articles about sports!- allow marking of group / articles as readdocs [LOW]
Grammar: 'group' should be plural 'groups' to match 'articles'.
@ -0,0 +4,4 @@- order articles in a group by article creation/upate datetime so that newst articles in a group / aggregate are always at the top- implement configurable "ignore" rules. i.e. I am totally unintersted in any type of sports and don't want to see groups / articles about sports!- allow marking of group / articles as read- allow having read articles / groups hidden (this should be configurable / a toggle)docs [LOW]
Awkward phrasing: 'allow having read articles / groups hidden' could be reworded as 'allow read articles / groups to be hidden'.
🔴 Not actioned — maintainer instruction
Todo.mdtypo ·Todo.mdwording ·Todo.mdtypos ·Todo.mdtypo ·Todo.mdgrammar ·Todo.mdphrasingTodo.mdis Marvin8's personal improvement tracker, added to the repository verbatim at his explicit instruction ("do not act on anything in the Todo.md file"). Content changes to it are the maintainer's call alone — the inline suggestions are recorded above for him to take or leave.WuMing
Found 5 issue(s). See inline comments below.
@ -0,0 +1,7 @@- Download full text of articlesdocs [MEDIUM]
The file starts directly with a list item and has no document title, intro, or file-level metadata (owner, date, status), so it is impossible for a reader to tell what project it belongs to or what 'articles' refers to outside the PR description. Add a heading (e.g.
# Todo) plus a one-line description of the scope and, since the PR states this was started by Marvin8, an author/date line so future contributors know whom to ask.@ -0,0 +1,7 @@- Download full text of articles- Download image / images for all articles- Make images at least twice as wide to use more of the horizontal space within the card; the amount of horizontal space should be configurable as well.docs [MEDIUM]
This bullet bundles two independent requests (widen images, and make the horizontal usage configurable) into one item, which makes it impossible to track or close them separately. It is also unquantified: 'at least twice as wide' does not say twice as wide as what (the source image, the current rendered size, the card?). Split into two bullets and state the reference dimension, e.g. 'Render article images at 2x their current width within the card' and 'Make the card's horizontal image allocation configurable'.
@ -0,0 +1,7 @@- Download full text of articles- Download image / images for all articles- Make images at least twice as wide to use more of the horizontal space within the card; the amount of horizontal space should be configurable as well.- Order articles in a group by article creation/update datetime so that the newest articles in a group / aggregate are always at the topdocs [LOW]
'article creation/update datetime' leaves the sort key undefined when the two disagree — an article created earlier but updated later could sort either way, and the behaviour is not specified for items with no update timestamp. Clarify whether the ordering is by creation date, last-updated date, or updated date falling back to creation date.
@ -0,0 +2,4 @@- Download image / images for all articles- Make images at least twice as wide to use more of the horizontal space within the card; the amount of horizontal space should be configurable as well.- Order articles in a group by article creation/update datetime so that the newest articles in a group / aggregate are always at the top- Implement configurable "ignore" rules — e.g. I am totally uninterested in any type of sports and don't want to see groups / articles about sports!docs [LOW]
Formatting is inconsistent across the list: lines 3 and 5 end with terminal punctuation while lines 1, 2, 4, 6 and 7 do not. This line is also written in first-person editorial voice ('I am totally uninterested') and is far longer than the other items, unlike the terse imperative style used elsewhere. Rewrite as a neutral, concise requirement (e.g. 'Support configurable ignore rules so users can suppress groups/articles by topic or keyword') and apply one consistent punctuation convention to the whole file.
@ -0,0 +4,4 @@- Order articles in a group by article creation/update datetime so that the newest articles in a group / aggregate are always at the top- Implement configurable "ignore" rules — e.g. I am totally uninterested in any type of sports and don't want to see groups / articles about sports!- Allow marking groups / articles as read- Allow read articles / groups to be hidden (this should be configurable / a toggle)docs [LOW]
The parenthetical 'this should be configurable / a toggle' is ambiguous: the slash leaves it unclear whether the intent is a persistent setting, a temporary UI toggle, or both, and 'read articles / groups' also conflates two different hide targets. State the expected behaviour explicitly, e.g. 'Allow hiding read articles and read groups independently; expose each as a persistent setting'.
🔴 Not actioned — maintainer instruction (personal tracker)
Todo.mdintro/title ·Todo.mdimages bullet ·Todo.mdsort key ·Todo.mdformatting/voice ·Todo.mdtoggle ambiguityTodo.mdis Marvin8's personal improvement tracker, deliberately kept as a lightweight list in his own voice. Typos and grammar were fixed with his approval (ecd6e71); restructuring, quantification, and spec-level precision are out of scope for this file by maintainer instruction. The substantive points — splitting the images bullet, defining the ordering sort key, and pinning down the hide-read toggle — will be resolved properly when the items are filed as issues with findings and plans.Closing: the whole point of this file was to capture the improvement list, and every item is now filed as a proper issue with findings and plans (#18 read/unread, #19 ordering, #20 ignore rules, #21 image persistence, #22 image layout, #23 full text). The tracker is superseded — Todo.md will not land on main.
Pull request closed