CRY-56: docs(linear): add Ash domain ERD and AGENTS.md maintenance contract - #142
Merged
Conversation
Creates documents/ash-domain-erd.adoc as the canonical inventory of the LinearCli.Linear domain, covering all 8 resources, 20 actions, 17 domain code interfaces, GraphQL/nested-data associations, and shared helpers (Issue.Update, Paginate). Adds a Domain documentation section to AGENTS.md requiring same-change updates to the ERD whenever domain structure changes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…butes Move the erDiagram block to appear immediately after the architecture overview, before the text tables. Expand the diagram to include full entity attribute boxes for all 8 resources, using the target resource name as the type for nested-struct fields (e.g. User assignee, Team[] teams). Relabel the text tables as explicit accessible-text equivalents rather than primary content. No changes to action/interface matrix, shared helpers, or maintenance contract sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Member
Author
Rework — run 2Addressed review feedback: "This is built as a table. Can we use mermaid to make a better looking ERD?" The document already contained a Mermaid
No changes to the action/interface matrix, shared helpers, or maintenance contract sections. |
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
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
documents/ash-domain-erd.adocas the canonical, current inventory of theLinearCli.LinearAsh domain## Domain documentationsection toAGENTS.mdwith an explicit same-change maintenance contractWhat the ERD document contains
LinearCli.ApidirectlyerDiagramblock) with all associations labeled[nested]Issue.Update(shared issueUpdate mutation runner for 4 update actions) andPaginate(cursor-based pagination used by 3 read actions)Test plan
mix compile --warnings-as-errorspasses (no Elixir changes)mix test— 12 tests, all pass (no code changes)documents/, accurately reflects the codeAGENTS.mdmaintenance contract is specific and actionabledocuments/project-structure.adoccross-link deferred (CRY-55 not yet merged)Closes https://linear.app/cryptokairos/issue/CRY-56/document-and-maintain-the-ash-domain-erd
🤖 Generated with Claude Code