Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

comments edits #715

Merged
merged 7 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 51 additions & 10 deletions docs/getting-started/collaborate/comment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,27 @@ You can add comments on various objects from your metadata.

You can add comments to the following areas:

### General
### Explorer Tab

#### Supergraph Page

<Thumbnail src="/img/get-started/comments_supergraph.png" alt="Hover over fields to add comments" width="800" />
<br />

#### Subgraph Page

<Thumbnail src="/img/get-started/comments_subgraph.png" alt="Hover over fields to add comments" width="500" />
<br />

#### Models --> General

- Description
- Signature
- GraphQL root fields

<Thumbnail src="/img/get-started/console_comment-general.png" alt="Comments on General" width="1000" />

### Fields & Relationships
#### Models --> Fields & Relationships

- Output fields
- Arguments
Expand All @@ -63,7 +75,7 @@ You can add comments to the following areas:
width="1000"
/>

### Permissions
#### Models --> Permissions

- Role
- Read
Expand All @@ -72,6 +84,26 @@ You can add comments to the following areas:
- Delete

<Thumbnail src="/img/get-started/console_comment-permissions.png" alt="Comments on Permissions" width="1000" />
<br />
<br />

### GraphiQL Tab

<Thumbnail src="/img/get-started/comments_graphql.png" alt="Alt text" />
<br />
<br />

### Insights Tab

<Thumbnail src="/img/get-started/comments_insights.png" alt="Comments on Permissions" width="1000" />

<br />
<br />

### Builds Tab

<Thumbnail src="/img/get-started/comments_builds.png" alt="Comments on Permissions" width="1000" />


## Notifications

Expand All @@ -80,22 +112,31 @@ To ensure effective collaboration, you can tag subgraph collaborators in your co
1. Type `@` in your comment.
2. Select the collaborator you want to notify.

Tagged collaborators will receive an email with your comments, keeping them informed of any discussions or questions.
Tagged collaborators will receive an email with your comments and a notification on the notification hub on the console,
keeping them informed of any discussions or questions.

The notification hub can be found in the top right corner of the console. On clicking the comments button, you will see all the comments
where you are tagged in one place. The messages will be grouped based on the underlying commenting thread. You can click on a particular comment (deep linking) and go to the original thread on the console.
You can also delete notifications from that menu.

{/* <Thumbnail src="/img/get-started/comments_notification.png" alt="Alt text" width="100" height="100" /> */}
![Alt text](/img/get-started/comments_notification.png)
<br />
<br />

:::info Invite collaborators

You can learn how to invite collaborators [here](/getting-started/collaborate/invite.mdx).


:::

## Limitations

The feature is in early access and has known limitations, which are in our backlog. Let us know if you would like to
prioritize any specific functionality.

1. Deep Linking of comments - directly go to comment thread using its link.
2. Notification Email on Resolving comments.
3. Ability to auto notify subgraph admin and developers.
4. Commenting on other pages of console such as GraphiQL and Insights.
5. History Tab for comments.
6. Insights/Analytics on comments.
1. Notification Email on Resolving comments.
2. Ability to auto notify subgraph admin and developers.
3. History Tab for comments.
4. Figma Style (Canvas) Commenting.
Binary file added static/img/get-started/comments_builds.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/comments_graphql.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/comments_insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/comments_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/comments_subgraph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/comments_supergraph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading