ENG-2119 Document the mapping between CrossApp types and the Concept table - #1290
ENG-2119 Document the mapping between CrossApp types and the Concept table#1290maparent wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
85ccb9f to
5c1d335
Compare
With fixes from Claude, Devin and Graphite
5c1d335 to
6c633fb
Compare
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a20b72b2c4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| | CrossAppNodeSchema | Content | value | | ||
| | ------------------ | ----------------------------------- | ----- | | ||
| | `label` | `name`, `literal_content->label` | {} | |
There was a problem hiding this comment.
Remove the nonexistent node-schema label mapping
When a CrossAppNodeSchema is converted by crossAppNodeSchemaToDbConcept, label is assigned only to name; its literal_content is built solely from template and template_content. Consequently, group-published schemas converted through this path do not have literal_content->label, so consumers relying on the documented mapping will fail to find it.
Useful? React with 👍 / 👎.
|
|
||
| | CrossAppNodeSchema | Content | value | | ||
| | ------------------ | ----------------------------------- | ----- | | ||
| | `label` | `name`, `literal_content->label` | {} | |
|
|
||
| | CrossAppNode | Concept | value | | ||
| | ----------------------- | ----------------------------------------------- | ------------------ | | ||
| | `content->direct->text` | `name` | false | |
There was a problem hiding this comment.
Incorrect value in the mapping table. The name column should contain the text from content->direct->text, not the boolean value false. The value false appears to be misaligned and actually belongs to the is_schema field in the next row (line 133).
| `content->direct->text` | `name` | |
| - | `is_schema` | false |This documentation error could mislead developers implementing the mapping between CrossAppNode and Concept.
| | `content->direct->text` | `name` | false | | |
| | `content->direct->text` | `name` | | | |
| | - | `is_schema` | false | | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
mdroidian
left a comment
There was a problem hiding this comment.
I'll approve, but there are two changes required still
- change
DiscourseGraphtoDiscourse Graph - address the new graphite comment
|
|
||
| This document aims to explain the rationale of the Concept table, and how it relates to Discourse Graph data structures. | ||
|
|
||
| ## DiscourseGraph structures |
There was a problem hiding this comment.
Let's please change this to Discourse Graph
|
|
||
| ## DiscourseGraph structures | ||
|
|
||
| DiscourseGraph assumes a basic graph data model: All knowledge objects are Nodes (with literal properties and a text description) or Relations between Nodes (without attributes other than its source or destination.) |
There was a problem hiding this comment.
Let's please change this to Discourse Graph
|
|
||
| ### Use cases | ||
|
|
||
| Having ObjectProperties makes it possible to represent certain special cases of DiscourseGraphs, such as the necessary relation between Evidence and Source. |
There was a problem hiding this comment.
Let's please change this to Discourse Graph
|
|
||
| | CrossAppNode | Concept | value | | ||
| | ----------------------- | ----------------------------------------------- | ------------------ | | ||
| | `content->direct->text` | `name` | false | |
https://linear.app/discourse-graphs/issue/ENG-2119/document-the-mapping-between-crossapp-types-and-the-concept-table
This is documentation, I really think it does not need a Loom demo.