[1/6] docs: set up agent-skill conventions and domain glossaries#422
[1/6] docs: set up agent-skill conventions and domain glossaries#422freshtonic wants to merge 4 commits into
Conversation
📝 WalkthroughWalkthroughAdds agent guidance for Linear issue management and triage, plus a context map and package glossaries covering Proxy, EQL Mapper, shared terminology, ADR usage, and a documented capability-model gap. ChangesAgent and Domain Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
…n docs Record where issues live and how domain documentation is laid out, so engineering skills read from the right places instead of assuming defaults. - Issue tracker is Linear (Product Engineering, CIP-), not GitHub Issues. GitHub holds code and PRs only. Prefers linear-cli for writes since the Linear MCP tools are unavailable in headless runs. - Domain docs are multi-context: CONTEXT-MAP.md points at per-package CONTEXT.md files under packages/*/. Per-package glossaries and ADRs are created lazily, so their absence is expected. No triage labels recorded; the triage skill is not installed. Stable-Commit-Id: q-5q3yy9rhgw8n99g19fbvgkytvr
Stable-Commit-Id: q-56zbh5gc0z7wg9g0q81b58csv7
3010414 to
ad36391
Compare
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 `@docs/agents/domain.md`:
- Around line 28-39: Specify the text language on the fenced directory-tree
block in the documentation by changing its fence to text, preserving the
existing tree content unchanged.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: a4e1f88e-d3dd-4bbe-9428-ba13993aa6b9
📒 Files selected for processing (7)
CLAUDE.mdCONTEXT-MAP.mddocs/agents/domain.mddocs/agents/issue-tracker.mddocs/agents/triage-labels.mdpackages/cipherstash-proxy/CONTEXT.mdpackages/eql-mapper/CONTEXT.md
|
Docs-only. Verified: code references are accurate ( Minor, non-blocking:
|
Minor documentation cleanups from the #422 review: - domain.md: language the directory-tree fence (`text`) so it passes markdownlint MD040. - domain.md: replace the copied-in `ADR-0007 (event-sourced orders)` example (no such ADR, wrong domain) with a neutral placeholder. - triage-labels.md: drop the leftover reader-instruction line. - CLAUDE.md: add the missing trailing newline. The review's manager.rs:146 line-ref nit in CONTEXT-MAP.md and eql-mapper's CONTEXT.md is intentionally left alone: downstream commits in this stack rewrite those exact passages, so editing them here only conflicts. Stable-Commit-Id: q-7jzthb123a03fjybs06t5ptvbr
Resolve the terms that collide hardest across the two contexts, and correct the Index entry in CONTEXT-MAP.md, which had the collision backwards. - EqlTrait is a capability; the storage that satisfies it is a SEM term (searchable encrypted metadata), many-to-one. Neither is an index. - Ban 'session' in Proxy: the code used it for both a connection and a single statement, and PostgreSQL owns the word for a third thing. - Split EncryptConfig into encrypt credentials vs column encrypt config; the single name currently covers two unrelated public structs. - Record that Proxy assigns EqlTraits::all() to every encrypted column, so EQL Mapper's bound checking cannot fire in production. Stable-Commit-Id: q-0tpfq3xh26grdk0fwpcxr1v6hg
ad36391 to
874be05
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTEXT-MAP.md (1)
29-36: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winReplace brittle line-number references with stable source anchors.
Both glossaries should reference the
SchemaManager/EqlTraits::all()symbol instead ofmanager.rs:146; otherwise the documentation will become incorrect after routine source edits.
CONTEXT-MAP.md#L29-L36: update the capability-gap reference.packages/eql-mapper/CONTEXT.md#L95-L102: update the known-model-gap reference.🤖 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-MAP.md` around lines 29 - 36, Replace the brittle manager.rs:146 reference in the capability-gap entry of CONTEXT-MAP.md with stable anchors naming SchemaManager and EqlTraits::all(). Apply the same reference update in packages/eql-mapper/CONTEXT.md’s known-model-gap entry; both documentation sites require direct changes.
🤖 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.
Nitpick comments:
In `@CONTEXT-MAP.md`:
- Around line 29-36: Replace the brittle manager.rs:146 reference in the
capability-gap entry of CONTEXT-MAP.md with stable anchors naming SchemaManager
and EqlTraits::all(). Apply the same reference update in
packages/eql-mapper/CONTEXT.md’s known-model-gap entry; both documentation sites
require direct changes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 487f02d4-fb8a-45cb-a6fb-44db6ae2af22
📒 Files selected for processing (6)
CLAUDE.mdCONTEXT-MAP.mddocs/agents/domain.mddocs/agents/triage-labels.mdpackages/cipherstash-proxy/CONTEXT.mdpackages/eql-mapper/CONTEXT.md
💤 Files with no reviewable changes (1)
- docs/agents/triage-labels.md
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/cipherstash-proxy/CONTEXT.md
- CLAUDE.md
|
Addressed the review nits (all pushed) →
Left as-is, on purpose:
|
📚 eql-v3 PR · 1 of 6
Part of a queue. The PRs merge in FIFO order — the numbered order below, #1 first. Merging one supersedes the PRs after it until the author runs
git queue sync(rebases the rest onto the merged base) andgit queue submit(retargets their PRs).✅🟢 #422
queue/eql-v3/setup-skills→main👈 this PR✅🟢 #423
queue/eql-v3/upgrade-deps→queue/eql-v3/setup-skills♻️🟢 #424
queue/eql-v3/typecheck→queue/eql-v3/upgrade-deps✅🟢 #428
queue/eql-v3/transform→queue/eql-v3/typecheck✅🟢 #426
queue/eql-v3/showcase→queue/eql-v3/transform⏳🟢 #427
queue/eql-v3/integration→queue/eql-v3/showcase✅ approved · ♻️ changes requested · ⏳ review pending | 🟣 merged · 🟢 open · ⚫ closed — status as of the last
git queue submit.🥞 Managed by git-queue — do not edit this list by hand.
About this queue
Migrates CipherStash Proxy from EQL v2 to EQL v3 (cipherstash-client 0.34.1-alpha.4 → 0.42.0, EQL 2.3.0-pre.3 → 3.0.2), replacing the opaque eql_v2_encrypted composite type with 53 typed jsonb domains that encode both scalar type and searchable capability in the column type itself.
About this branch
Set up the Matt Pocock skills which will we use to drive the subsequent changes.