docs(kanvas): update hierarchical relationship definitions, add visual example and added evaluation engine description #1137
Conversation
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Kanvas documentation by renaming and refining the hierarchical relationship subtypes to "Hierarchical-Parent-Inventory" and "Hierarchical-Parent-Wallet", complete with updated descriptions and illustrative GIFs. Additionally, it introduces a new section to the relationship evaluation page explaining the core responsibilities of the evaluation engine. Feedback was provided to correct inconsistent indentation and fix a capitalization typo ("wallet" to "Wallet") in the newly added description.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| **ii. Hierarchical-Parent-Wallet** | ||
|
|
||
| A parent-child relationship implies that the parent component must be present or established before the child component can be created. For instance, in Kubernetes, a 'Namespace' can serve as a parent to 'Pods' within that namespace. Therefore, the namespace must be created beforehand for pods to be deployed within it. Here's an example of a Hierarchical-Parent relationship | ||
| This is a relationship between components where one component is directly attached to a host component, acting as an integrated inventory item. This implies a reverse configuration dependency: the configuration settings of the parent component are mutated or updated to synchronize with the attached child component. For example, attaching a sidecar container or a WebAssembly (WASM) filter to a workload will automatically modify the host workload's configuration to include the new item. On the canvas, these attached items are visualized as a numeric design inventory badge on the parent component rather than as standalone shapes. Here's an example of a Hierarchical-Parent-wallet relationship |
There was a problem hiding this comment.
The paragraph indentation is inconsistent with the first list item (which uses 2 spaces of indentation on line 97), and "Hierarchical-Parent-wallet" uses a lowercase "w" for "wallet" which is inconsistent with the heading on line 101. Please adjust the indentation to 2 spaces and capitalize "Wallet".
| This is a relationship between components where one component is directly attached to a host component, acting as an integrated inventory item. This implies a reverse configuration dependency: the configuration settings of the parent component are mutated or updated to synchronize with the attached child component. For example, attaching a sidecar container or a WebAssembly (WASM) filter to a workload will automatically modify the host workload's configuration to include the new item. On the canvas, these attached items are visualized as a numeric design inventory badge on the parent component rather than as standalone shapes. Here's an example of a Hierarchical-Parent-wallet relationship | |
| This is a relationship between components where one component is directly attached to a host component, acting as an integrated inventory item. This implies a reverse configuration dependency: the configuration settings of the parent component are mutated or updated to synchronize with the attached child component. For example, attaching a sidecar container or a WebAssembly (WASM) filter to a workload will automatically modify the host workload's configuration to include the new item. On the canvas, these attached items are visualized as a numeric design inventory badge on the parent component rather than as standalone shapes. Here's an example of a Hierarchical-Parent-Wallet relationship |
References
- Use hyphens for compound adjectives modifying a noun (e.g., 'Hierarchical-Parent-Wallet relationship').
|
🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1137/
|
2 participants
Description:
Added a detailed explanation for the Hierarchical-Wallet relationship and evaluation engine description. Replaced incorrect and static SVG diagrams with accurate, animated GIFs for both the Wallet and Inventory relationships to better demonstrate the UI interactions in Kanvas.
Signed commits