Skip to content

docs: add herdr domain glossary (CONTEXT.md) - #2457

Closed
brchue-ux wants to merge 1 commit into
herdrdev:masterfrom
brchue-ux:fm/herdr-context-glossary
Closed

docs: add herdr domain glossary (CONTEXT.md)#2457
brchue-ux wants to merge 1 commit into
herdrdev:masterfrom
brchue-ux:fm/herdr-context-glossary

Conversation

@brchue-ux

Copy link
Copy Markdown

Summary

Adds a CONTEXT.md domain glossary at the repo root, per the domain-modeling skill's
CONTEXT-FORMAT.md structure (one-line term definitions with _Avoid_ synonyms), and a pointer
to 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 against
docs/next/website/src/content/docs/concepts.mdx where user-facing docs already define a term.

Terms covered: session, workspace, tab, pane (PaneState vs PaneRuntime), space, sidebar, agent
detection, 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:

  • "Space" is genuinely overloaded in the codebase — it names both a workspace's git/worktree
    identity (GitSpaceMetadata, WorktreeSpaceMembership) and the sidebar's per-workspace summary
    section/config ([ui.sidebar.spaces]). I defined it as "the git/worktree identity a workspace is
    derived from" and noted the sidebar section is named after that concept — but if the intended
    canonical meaning is different, this entry needs correcting.
  • Agent state has a 4-vs-5 value mismatch between code and docs. The AgentState enum has 4
    variants (Idle, Working, Blocked, Unknown); user-facing docs describe 5 including Done.
    Done is not a backend state — it's a UI label derived from Idle + PaneState.seen == false
    (src/ui/status.rs). I split this into two glossary entries ("Agent state" and "Done") rather
    than presenting docs' 5-state table as one flat enum — flagging in case that framing is wrong.
  • "Presentation" is confirmed live, not deprecated — it's agent-reported display metadata
    (EffectivePresentation: title, display name, per-state labels) layered on top of AgentState.

Test plan

  • Docs-only change; no build/test impact.
  • Captain review of term accuracy and any missing/wrong entries.

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • ai-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8a9fa036-af3e-433a-a346-d27d8df11fde

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

@kangal-bot

Copy link
Copy Markdown
Collaborator

Hi @brchue-ux, thanks for your interest in contributing.

Herdr does not accept unsolicited implementation pull requests from contributors who are not listed in .github/APPROVED_CONTRIBUTORS.

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.

@kangal-bot kangal-bot closed this Aug 7, 2026
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.

2 participants