Skip to content

docs(comments): document Markdown rendering in comment thread UI #50

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.

Sign up for GitHub

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

Open
chiplay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(comments): document Markdown rendering in comment thread UI #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .claude-plugin/marketplace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{
"name": "subtext",
"source": "./",
"version": "0.2.2",
"version": "0.2.3",
"description": "Tools that let coding agents verify and show their work against your running application",
"category": "development",
"keywords": ["subtext", "automation", "verification", "testing", "session-replay", "debugging", "fullstory"],
Expand Down
2 changes: 1 addition & 1 deletion .claude-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "subtext",
"version": "0.2.1",
"version": "0.2.3",
"description": "Tools for agents to build with Subtext",
"license": "MIT",
"author": {
Expand Down
2 changes: 1 addition & 1 deletion .codex-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "subtext",
"version": "0.2.1",
"version": "0.2.3",
"description": "Tools that let coding agents verify and show their work against your running application",
"author": {
"name": "Subtext",
Expand Down
2 changes: 1 addition & 1 deletion .cursor-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "subtext",
"description": "Tools that let coding agents verify and show their work against your running application",
"version": "0.2.0",
"version": "0.2.3",
"license": "MIT",
"author": {
"name": "Subtext",
Expand Down
11 changes: 11 additions & 0 deletions skills/comments/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ Comment tools do **not** auto-capture screenshots. To attach a screenshot, pass

When the comment is about a specific element, capture a focused clip by passing `component_id` (and a small `expand_pct` for context) to the screenshot tool. A focused clip is far more useful in a comment than a full viewport — the reader sees exactly what you're pointing at.

## Markdown

Comment text is rendered as **Markdown** in the comment thread UI. Use standard formatting freely:

- **Bold** / *italic* for emphasis
- Bulleted and numbered lists for structured observations
- `code spans` and fenced code blocks for selectors, error messages, or snippets
- [Links](url) to reference external evidence or docs

Keep formatting proportional to the comment — a one-line observation doesn't need a bulleted list.

## Intents

When adding a comment, classify it:
Expand Down