feat: architecture docs - #155
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR expands documentation coverage for the harness-node system by publishing comprehensive architecture and per-worker documentation into the repository, enabling git tracking. It includes system design diagrams, worker interface catalogs, and a refinement to the agent's plan-mode system prompt. ChangesHarness-Node Documentation and System Prompt
🎯 2 (Simple) | ⏱️ ~10 minutes Possibly Related PRs
Suggested Reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
skill-check — worker0 verified, 10 skipped (no docs/).
Three for three. Nicely done. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@harness-node/docs/workers/context-compaction.md`:
- Line 17: The doc mixes British and American spellings—replace all British
variants with American ones: change "summarises" to "summarizes" and "summarise"
to "summarize" across the file (notably the occurrence at the sentence
containing "messages, summarises, the older prefix..." and the other instances
noted), ensure existing American usage like "SUMMARIZER" and "summarize.ts"
remains unchanged, and run a quick grep for "summaris" to catch any remaining
British forms and update them to the American spelling.
🪄 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: CHILL
Plan: Pro
Run ID: 81036e8f-c88e-4c13-9492-998e1d851015
📒 Files selected for processing (15)
.gitignoreharness-node/README.mdharness-node/docs/architecture.mdharness-node/docs/workers/approval-gate.mdharness-node/docs/workers/auth-credentials.mdharness-node/docs/workers/context-compaction.mdharness-node/docs/workers/harness.mdharness-node/docs/workers/hook-fanout.mdharness-node/docs/workers/llm-budget.mdharness-node/docs/workers/models-catalog.mdharness-node/docs/workers/provider-anthropic.mdharness-node/docs/workers/provider-openai.mdharness-node/docs/workers/session.mdharness-node/docs/workers/turn-orchestrator.mdharness-node/src/turn-orchestrator/system-prompt.ts
💤 Files with no reviewable changes (1)
- .gitignore
| cache_read`, excluding `cache_write`) crosses the configured threshold, | ||
| it acquires a per-session single-writer lease, asks `session-tree` for | ||
| the active path, splits off the last `COMPACT_KEEP_RECENT_TURNS` | ||
| messages, summarises the older prefix via the configured provider's |
There was a problem hiding this comment.
Standardize spelling: use American English consistently.
The document mixes British English ("summarises", "summarise") with American English ("summarizer", "summarize"). Pick one variant and use it throughout—American English is more common in technical documentation.
📝 Suggested standardization
Change all occurrences to American spelling:
- Line 17: "summarises" → "summarizes"
- Line 60: "summarise" → "summarize"
- Lines 80-81: Keep "SUMMARIZER" (already American)
- Line 99: Keep "summarize.ts" (already American)
Also applies to: 60-60, 80-81, 99-99
🤖 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 `@harness-node/docs/workers/context-compaction.md` at line 17, The doc mixes
British and American spellings—replace all British variants with American ones:
change "summarises" to "summarizes" and "summarise" to "summarize" across the
file (notably the occurrence at the sentence containing "messages, summarises,
the older prefix..." and the other instances noted), ensure existing American
usage like "SUMMARIZER" and "summarize.ts" remains unchanged, and run a quick
grep for "summaris" to catch any remaining British forms and update them to the
American spelling.
This was referenced May 20, 2026
Merged
This was referenced Jul 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
Chores