Commenting¶

!!! info "TL;DR" Add comments to submissions to ask questions, provide context, or discuss implementation. Comments support Markdown formatting. Official team responses are marked with a special badge. Replying to a comment automatically follows you on the submission.

Why Comment?¶

Comments create a dialogue between users and the product team:

• Ask clarifying questions — "Would this work for mobile too?"
• Provide additional context — "I've seen this issue 3 times this week"
• Discuss implementation — "Could we use the existing settings modal for this?"
• Share workarounds — "You can achieve this by doing X for now"
• Upvote alternative approaches — "+1 for the dark mode toggle idea"

Comments are public and visible to all users.

Adding a Comment¶

Step 1: Navigate to the Submission¶

Open the submission detail page by clicking the title from the feedback board or roadmap.

Step 2: Scroll to the Comment Section¶

Comments appear below the submission description.

Step 3: Write Your Comment¶

Type your comment in the text area. Markdown is supported:

Supported Markdown:

**Bold text** _Italic text_ `Code snippets` [Links](https://example.com)

- Bulleted lists
- More items

> Blockquotes for emphasis

# Headers (H1-H6)

Rendered example:

Step 4: Submit¶

Click "Post Comment". Your comment appears immediately at the bottom of the thread.

!!! info Posting a comment automatically follows you on the submission. You'll receive notifications for future comments and status changes.

Official Team Responses¶

Comments from team members are marked with an "Official Response" badge:

🟣 Official Response | Jane Doe (Product Manager)

We're planning to include this in the Q3 roadmap. I'll update the status to "Planned"
once we finalize the sprint schedule.

The badge helps users quickly identify authoritative updates from the product team.

How Official Responses Work¶

• Only users in the team_members table can post official responses
• The badge appears automatically based on the commenter's role
• Official responses are highlighted with a purple accent border

Replying to Comments¶

Threaded Replies¶

You can reply directly to a comment:

1. Click "Reply" below the comment
2. Type your reply (Markdown supported)
3. Click "Post Reply"

Replies are indented to show the thread structure:

🔷 Alice (User)
"Would this work on mobile?"

  🔸 Bob (Team Member)
  "Yes, we're designing it mobile-first."

  🔸 Charlie (User)
  "Great! Can't wait to try it."

Notification on Replies¶

When someone replies to your comment, you'll get a notification (email or in-app, depending on your preferences).

Editing and Deleting Comments¶

Editing Your Comment¶

You can edit your comment for 15 minutes after posting:

1. Click the three-dot menu (⋮) on your comment
2. Select "Edit"
3. Make changes and click "Save"

After 15 minutes, comments are locked to preserve conversation history.

Deleting Your Comment¶

You can delete your comment if:

• It has no replies
• It's less than 24 hours old

1. Click the three-dot menu (⋮) on your comment
2. Select "Delete"
3. Confirm deletion

Comments with replies cannot be deleted to avoid breaking the thread.

Comment Etiquette¶

Do's¶

• ✅ Be constructive and respectful
• ✅ Provide specific details, examples, or screenshots
• ✅ Use Markdown to format long comments for readability
• ✅ Reply to official responses with follow-up questions
• ✅ Upvote comments you agree with (👍 reaction)

Don'ts¶

• ❌ Post "+1" or "me too" (use the vote button instead)
• ❌ Be rude, dismissive, or combative
• ❌ Spam the thread with repeated messages
• ❌ Share sensitive data (passwords, API keys, personal info)
• ❌ Go off-topic or hijack the thread for unrelated feedback

Rate Limits¶

To prevent spam, Canviq enforces comment rate limits:

If you hit the limit, wait 60 minutes before commenting again.

Markdown Tips¶

Code Snippets¶

Use backticks for inline code or triple backticks for code blocks:

Inline: `const foo = 'bar'`

Block: \`\`\`javascript const greeting = 'Hello, world!' console.log(greeting)
\`\`\`

Links¶

Use descriptive link text instead of raw URLs:

Good: [See the docs](https://docs.canviq.app) Bad: https://docs.canviq.app

Lists¶

Use lists to organize multi-point comments:

Here are three reasons this would be useful:

1. Improves accessibility for screen reader users
2. Reduces clutter in the dashboard
3. Aligns with industry best practices

Notifications¶

When someone replies to your comment or posts a new comment on a followed submission, you'll receive a notification.

Notification Settings¶

Control comment notifications in Profile → Notifications:

• Realtime: Instant email for every comment
• Daily Digest: Summary of new comments once per day
• Weekly Digest: Weekly roundup of comments
• Off: No email notifications (in-app only)

Moderation¶

Comments are automatically scanned for spam and abuse. Flagged comments go to the moderation queue for manual review.

Spam examples:

• Repeated "+1" or "bump" comments
• Self-promotion or advertising
• Off-topic content unrelated to the submission

Repeated violations may result in account suspension.

Accessibility¶

Comment threads are fully accessible:

• Keyboard navigation: Tab through comments, Enter to reply
• Screen reader support: Comments announced with author, timestamp, and content
• High contrast mode: Works with browser and OS accessibility settings

What's Next?¶

After commenting:

• Track the roadmap for status updates
• Manage your notification preferences
• View all submissions you're following

Need help? Check the User Guide for more on using Canviq effectively.