DOC-752 | Graph Visualizer UI #701
Draft
Conversation
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
|
Deploy Preview Available Via |
|
Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: bluepal-shiva-darapaneni.
|
…ng the all usecases
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
Simran-B
changed the title
Simran-B
requested changes
May 21, 2025
| menuTitle: Graph Visualizer | ||
| weight: 85 | ||
| description: >- | ||
| Graph Visualizer allows you to visualize the graphs present in the database. |
There was a problem hiding this comment.
- Missing article
- Too vague, need a good value proposition here
- Shouldn't end with a period as per the Readme
| Graph Visualizer allows you to visualize the graphs present in the database. | ||
| --- | ||
|
|
||
| A **Graph** in ArangoDB is a powerful data structure that models relationships between entities. The **Graph Visualizer** provides an interactive interface to explore these connections, enabling users to traverse edges, inspect vertices, and intuitively understand the underlying data structure. |
There was a problem hiding this comment.
I'm not sure if we need to explain the concept of a graph in this context
|
|
||
| A **Graph** in ArangoDB is a powerful data structure that models relationships between entities. The **Graph Visualizer** provides an interactive interface to explore these connections, enabling users to traverse edges, inspect vertices, and intuitively understand the underlying data structure. | ||
|
|
||
| > 💡 **Note:** Graph creation is **not** performed within the Graph Visualizer. Graphs must be created in the **Graphs** section of the application. Once a graph is created there, it will automatically appear in the Graph Visualizer, ready for exploration and visualization. |
There was a problem hiding this comment.
This should use an Admonition, see Readme
| Right-click anywhere on the canvas and select **"Create Node"**. A dropdown will appear showing all related document collections. Select the desired collection (vertex type), provide a unique identifier or name, and create the node. The node will then appear in the visualization. | ||
|
|
||
| - **Step-1 : Right Click On Graph Area** | ||
| {{< image src="../../images/1a-Create_Node.png" >}} |
There was a problem hiding this comment.
Please use standard Markdown if you want to include images. This Shortcode is only for exceptional cases where custom styling needs to be specified or if the image should have a caption.
|
|
||
| > 💡 **Note:** Graph creation is **not** performed within the Graph Visualizer. Graphs must be created in the **Graphs** section of the application. Once a graph is created there, it will automatically appear in the Graph Visualizer, ready for exploration and visualization. | ||
|
|
||
| ## 1.Data Augmentation |
There was a problem hiding this comment.
I would generally avoid enumerations in headlines, and especially here where the content has no specific order (time/priority)
|
|
||
| While the Graph Visualizer is primarily designed for exploring graph data, you can also create and modify nodes and edges directly from the canvas. | ||
|
|
||
| **A.Add New Nodes (Vertices):** |
There was a problem hiding this comment.
To structure the content, you should use (un)ordered lists if the child content is rather short or sub-headings if it's larger. Enumerations need to be created with markup not free-text.
| While the Graph Visualizer is primarily designed for exploring graph data, you can also create and modify nodes and edges directly from the canvas. | ||
|
|
||
| **A.Add New Nodes (Vertices):** | ||
| Right-click anywhere on the canvas and select **"Create Node"**. A dropdown will appear showing all related document collections. Select the desired collection (vertex type), provide a unique identifier or name, and create the node. The node will then appear in the visualization. |
There was a problem hiding this comment.
- UI element labels should just be bold but not be wrapped in quote marks. Please see the reference page again: https://docs.arangodb.com/stable/components/web-interface/graphs/
- It's a dropdown menu. Maybe the term "context menu" is preferable? You can check the existing documentation, whether there is an established term already.
- Avoid using "will" etc., see https://developers.google.com/style/tense
| **A.Add New Nodes (Vertices):** | ||
| Right-click anywhere on the canvas and select **"Create Node"**. A dropdown will appear showing all related document collections. Select the desired collection (vertex type), provide a unique identifier or name, and create the node. The node will then appear in the visualization. | ||
|
|
||
| - **Step-1 : Right Click On Graph Area** |
There was a problem hiding this comment.
- Use markup for ordered list
- Should be right-click (hyphen)
- Is the idea for this to be like a headline? Otherwise, I don't understand the title case
|
|
||
| The top-left section of the Graph Visualizer includes powerful search and query tools for interactive exploration. | ||
|
|
||
| ##### 🔍 Search |
There was a problem hiding this comment.
- Please don't skip headline levels. Pages should have a sound structure.
- I'm not sure about the use of emoji
| These features allow better spatial understanding of node clusters, hierarchies, | ||
| and relationship flows. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Why a horizontal ruler here?
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
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.
Description
Upstream PRs