[1/3] docs: add domain glossaries for Proxy and EQL Mapper#420
Closed
freshtonic wants to merge 3 commits into
Closed
[1/3] docs: add domain glossaries for Proxy and EQL Mapper#420freshtonic wants to merge 3 commits into
freshtonic wants to merge 3 commits into
Conversation
…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. Queued-Commit-Id: q-5q3yy9rhgw8n99g19fbvgkytvr
Queued-Commit-Id: q-56zbh5gc0z7wg9g0q81b58csv7
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. Queued-Commit-Id: q-0tpfq3xh26grdk0fwpcxr1v6hg
📝 WalkthroughWalkthroughThis documentation-focused change adds agent guidance for Linear workflows and domain modeling, establishes a workspace context map, and adds Proxy and EQL Mapper glossaries describing terminology, cross-context relationships, and a known capability-model gap. ChangesAgent and domain documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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`:
- Line 28: Update the directory-tree code fence in domain.md to declare the text
language using ```text, while preserving the existing tree diagram content and
closing fence.
In `@packages/eql-mapper/CONTEXT.md`:
- Line 48: Update the resultset wording in CONTEXT.md to the standard “result
set” spelling, preserving the surrounding documentation text.
🪄 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: 5e35838f-05b9-434b-a4de-c7e308ba59dd
📒 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
|
|
||
| This repo is a Cargo workspace, so contexts live under `packages/`, not `src/`: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify a language for the directory-tree fence.
Line 28 triggers markdownlint MD040. Use ```text for the tree diagram.
Proposed fix
-```
+```text
/
├── CONTEXT-MAP.md🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 28-28: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@docs/agents/domain.md` at line 28, Update the directory-tree code fence in
domain.md to declare the text language using ```text, while preserving the
existing tree diagram content and closing fence.
Source: Linters/SAST tools
| _Avoid_: "term" meaning an encrypted search term; that sense belongs to Proxy. | ||
|
|
||
| **Projection**: | ||
| The resultset shape of a statement or subquery — an ordered list of optionally-named |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use the standard “result set” spelling.
Line 48 should say “result set” for clearer, conventional documentation wording.
🧰 Tools
🪛 LanguageTool
[grammar] ~48-~48: Ensure spelling is correct
Context: ... belongs to Proxy. Projection: The resultset shape of a statement or subquery — an o...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 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 `@packages/eql-mapper/CONTEXT.md` at line 48, Update the resultset wording in
CONTEXT.md to the standard “result set” spelling, preserving the surrounding
documentation text.
Source: Linters/SAST tools
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.
📚 Queued PR · 1 of 3
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).chore/setup-skills→main👈 this PRchore/eql-v3-deps→chore/setup-skillsfeat/eql-v3-typecheck→chore/eql-v3-deps✅ 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.
Summary by CodeRabbit