Skip to content

docs: changelog + context for 033/034/035 in-flight#43

Merged
archae0pteryx merged 1 commit intomainfrom
chore/docs-update
May 5, 2026
Merged

docs: changelog + context for 033/034/035 in-flight#43
archae0pteryx merged 1 commit intomainfrom
chore/docs-update

Conversation

@archae0pteryx
Copy link
Copy Markdown
Contributor

@archae0pteryx archae0pteryx commented May 5, 2026

Summary

Test plan

  • no code touched, no tests affected

Summary by CodeRabbit

  • Documentation
    • Expanded changelog with notes on validation, error mapping, and internal API organization.
    • Added docs for validated task text and domain validation errors and their mapping to command-level errors.
    • Marked several priority backlog items as in-progress and noted open PR status.
    • Cleaned and reorganized supporting issue and infra documentation.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Three documentation files updated: CONTEXT.md adds TaskText and DomainError docs; CHANGELOG.md expands the Unreleased section with notes on domain validation, markdown store tests, and IPC migration; issues/README.md marks issues 033–035 as in-progress with PR references.

Changes

Documentation Updates

Layer / File(s) Summary
Domain Concepts / Types
CONTEXT.md
Adds TaskText newtype (non-empty String) with TaskText::new(text) and documents DomainError variants EmptyTitle and EmptyTaskText, noting they map to CommandError::BadRequest.
Release Notes
CHANGELOG.md
Extends ## [Unreleased] with entries for PR #40 (new DomainError, validated focus/task constructors, DomainErrorCommandError mapping, regression tests), PR #41 (MarkdownFocusStore unit tests; corrupted timer.json now degrades timer to None), PR #39 (move pig/drag IPC into src/api/ with typed wrappers; components updated; guarded subscription cleanup), plus Taskfile and issues housekeeping.
Issue Tracking
issues/README.md
Marks issues 033–035 as in-progress ([~]) and appends “PR # open, awaiting review” status for each.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • killallgit/adhd-ranch#42: Similar repo documentation changes for archiving/moving issue markdown files and related housekeeping.

Poem

I nibble through changelogs, hopping light,
New types and errors stitched just right,
Tests and notes in tidy rows,
Three issues marked — the garden grows,
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: documentation updates to changelog, context, and issue tracking for issues 033/034/035 marked as in-flight.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-update

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTEXT.md`:
- Around line 35-40: The documentation currently states that TaskText,
DomainError, and the Commands::append_task mapping are implemented, but the
actual domain exports in crates/domain/src/focus.rs and crates/domain/src/lib.rs
do not expose these; update CONTEXT.md (the paragraph mentioning TaskText::new,
DomainError variants EmptyTitle/EmptyTaskText, and command-layer mapping) to
mark this behavior as planned/in-flight or conditionally state “after PR `#40`
merges” so the docs reflect the current contract accurately and avoid claiming
implemented APIs that aren’t yet exported.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3825c797-66d3-4a19-b133-264a61f29d8e

📥 Commits

Reviewing files that changed from the base of the PR and between dabed05 and 63b4d35.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • CONTEXT.md
  • issues/README.md

Comment thread CONTEXT.md
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
CONTEXT.md (1)

35-40: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Current-state wording still overstates in-flight domain behavior.

Line 35 through Line 40 describe TaskText, DomainError, and command-layer mapping as current behavior. Please gate this section as in-flight (for example, “after PR #40 merges”) so docs don’t imply already-merged API guarantees.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CONTEXT.md` around lines 35 - 40, The documentation currently describes
TaskText::new, DomainError (EmptyTaskText/EmptyTitle), and the mapping to
CommandError::BadRequest as if already merged; update the text around those
symbols (TaskText::new, NewFocus::new, DomainError::EmptyTaskText,
DomainError::EmptyTitle, Commands::append_task, CommandError::BadRequest) to
clearly mark this behavior as in‑flight—e.g. prefix or parenthesize with “(in
progress, pending PR `#40`)” or “(after PR `#40` merges)”—so readers know these API
guarantees are not yet final.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Duplicate comments:
In `@CONTEXT.md`:
- Around line 35-40: The documentation currently describes TaskText::new,
DomainError (EmptyTaskText/EmptyTitle), and the mapping to
CommandError::BadRequest as if already merged; update the text around those
symbols (TaskText::new, NewFocus::new, DomainError::EmptyTaskText,
DomainError::EmptyTitle, Commands::append_task, CommandError::BadRequest) to
clearly mark this behavior as in‑flight—e.g. prefix or parenthesize with “(in
progress, pending PR `#40`)” or “(after PR `#40` merges)”—so readers know these API
guarantees are not yet final.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9bdf5725-9ea5-45dc-815c-0d0239a8fa36

📥 Commits

Reviewing files that changed from the base of the PR and between 63b4d35 and 470e53b.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • CONTEXT.md
  • issues/README.md

- CHANGELOG: Unreleased entries for PRs #39 (033), #40 (034), #41
  (035), #42 (cleanup), and the Taskfile ralph-include fix
- CONTEXT: add TaskText and DomainError to the ubiquitous language
- issues/README: mark 033/034/035 as in-flight (PR open)
@archae0pteryx archae0pteryx merged commit 4787efe into main May 5, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant