docs: add herdr domain glossary (CONTEXT.md) - #2457
Conversation
|
Important Review skippedAuto reviews are limited based on label configuration. 🏷️ Required labels (at least one) (1)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
|
Hi @brchue-ux, thanks for your interest in contributing. Herdr does not accept unsolicited implementation pull requests from contributors who are not listed in The pull request author is not an approved contributor. If you encountered a reproducible bug, report the observed behavior through the bug issue template. A report does not reserve the work or authorize a pull request; accepted fixes are normally implemented by Herdr’s maintainer-controlled agents. Feature requests, behavior changes, and other proposals belong in GitHub Discussions. Do not open an issue merely to justify an implementation that was already written. If a maintainer explicitly wants this implementation, they can reopen the pull request. Reopening by anyone else will be closed again automatically. See https://github.com/herdrdev/herdr/blob/master/CONTRIBUTING.md for the contribution policy. |
Summary
Adds a
CONTEXT.mddomain glossary at the repo root, per thedomain-modelingskill'sCONTEXT-FORMAT.mdstructure (one-line term definitions with_Avoid_synonyms), and a pointerto it from
AGENTS.md.Docs-only change: no runtime behavior touched.
Scope and method
Definitions were grounded in the actual source (
src/workspace.rs,src/pane/state.rs,src/pane.rs,src/detect/mod.rs,src/detect/manifest.rs,src/config/sidebar.rs,src/api/mod.rs,src/server/socket_paths.rs,src/session.rs) and cross-checked againstdocs/next/website/src/content/docs/concepts.mdxwhere user-facing docs already define a term.Terms covered: session, workspace, tab, pane (
PaneStatevsPaneRuntime), space, sidebar, agentdetection, manifest, gate, agent state, done (the derived unseen-idle label), presentation, native
agent session, server socket vs client socket, event.
Notes for review — please correct freely
This is a first draft, not a final spec. A few things worth double-checking against intent rather
than just code:
identity (
GitSpaceMetadata,WorktreeSpaceMembership) and the sidebar's per-workspace summarysection/config (
[ui.sidebar.spaces]). I defined it as "the git/worktree identity a workspace isderived from" and noted the sidebar section is named after that concept — but if the intended
canonical meaning is different, this entry needs correcting.
AgentStateenum has 4variants (
Idle,Working,Blocked,Unknown); user-facing docs describe 5 includingDone.Doneis not a backend state — it's a UI label derived fromIdle+PaneState.seen == false(
src/ui/status.rs). I split this into two glossary entries ("Agent state" and "Done") ratherthan presenting docs' 5-state table as one flat enum — flagging in case that framing is wrong.
(
EffectivePresentation: title, display name, per-state labels) layered on top ofAgentState.Test plan