Skip to content

docs(readme): reflect v0.3.0 features (annotations, UI scaling, theme)#33

Merged
SDS-Mode merged 2 commits into
mainfrom
docs/readme-v0.3-features
Apr 15, 2026
Merged

docs(readme): reflect v0.3.0 features (annotations, UI scaling, theme)#33
SDS-Mode merged 2 commits into
mainfrom
docs/readme-v0.3-features

Conversation

@SDS-Mode
Copy link
Copy Markdown
Owner

README updates so the public landing page matches what `v0.3.0` actually ships. Doc-only — no code changes; CI will skip per the existing `paths-ignore`.

Diff summary

Section Change
Why trayce? Sharpened framing — pins/replies and push-back are the new differentiator vs. plain sketch tools
✨ Features "Bidirectional flow" → "Structured annotations" (headline v0.3.0 feature). Names `resolve_annotations` + `push_annotations`. `push_image` mention moved to the multi-session card so the capability stays surfaced.
Live session data card Now lists all 4 panel tabs (Response / Transcript / Usage / Annotations) + theme-accent threading note
Keyboard shortcuts Added `A` (annotate mode toggle) + `Esc` (exit). Annotate-mode-only `T` / `P` / `C` listed in a callout with the brush-suppression note
🎨 Theme & UI scaling (new subsection) Under Server management — documents the two scale sliders and accent-color threading into annotations
Environment variables Extended to match `.env.example` (`TRAYCE_CLIENT_DIR`, `TRAYCE_LABEL`, `TRAYCE_CONTAINER`) + link to the file

19 added / 7 removed lines. Section anchors unchanged so the existing ToC + external links remain valid.

Why open as a PR rather than push direct

The branch protection ruleset on `main` requires PRs for all changes — same reason #32 is open. README updates aren't critical but worth the same gate.

🤖 Generated with Claude Code

RCellar and others added 2 commits April 14, 2026 23:06
- "Why trayce?" sharpened — annotations close the review loop in both
  directions; explicit per-pin reply / push-back framing
- Replace "Bidirectional flow" feature card with "Structured annotations"
  (richer + headline of v0.3.0); names resolve_annotations + push_annotations
- "Live session data" card now lists all 4 panel tabs
  (Response / Transcript / Usage / Annotations) and notes theme-accent threading
- "Multi-session support" card mentions push_image (preserves the
  bidirectional capability that the renamed card no longer implies)
- Keyboard shortcuts table gains A (annotate mode), Esc (exit) + a
  callout listing T/P/C tool keys active inside annotate mode
- Env vars table extended to match .env.example: TRAYCE_CLIENT_DIR,
  TRAYCE_LABEL, TRAYCE_CONTAINER (+ a link to the .env.example file)
- New "🎨 Theme & UI scaling" subsection under Server management
  documenting the two scale sliders and accent threading

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Filling in fields npm/registry tooling expects. No runtime impact.
Side effect: this PR now touches a non-ignored file so CI fires
(README-only branch was being blocked by required-status-check ruleset).
@SDS-Mode SDS-Mode merged commit 131afbb into main Apr 15, 2026
2 checks passed
@SDS-Mode SDS-Mode deleted the docs/readme-v0.3-features branch April 15, 2026 03:13
SDS-Mode pushed a commit that referenced this pull request Apr 15, 2026
Previously both push and pull_request events used paths-ignore to skip
markdown/docs-only changes. The main branch ruleset requires the
`ci (ubuntu-latest)` and `ci (windows-latest)` contexts to pass before
merge — but paths-ignore meant those contexts never fire for docs-only
PRs, deadlocking the merge. We hit this on PR #33 (README sync) and
again now on PR #36 (changelog).

Drop paths-ignore from pull_request; keep it on push. PR CI always runs
so the required contexts resolve; post-merge push to main still skips
docs-only commits so we pay the CI cost at most once per docs-only change.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
SDS-Mode added a commit that referenced this pull request Apr 15, 2026
* docs(changelog): capture post-v0.3.0 work

Adds a new Unreleased section covering PRs #34 (perf: drawing lag), #35
(feat: UI polish pass + follow-up fixes), and #31 (chore: 5 hygiene
fixes). Renames the previously-stale Unreleased block to [0.3.0] —
2026-04-14 (dated to the v0.3.0 tag). Header now links to all three
tagged releases.

No code changes.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* ci: run PRs unconditionally, keep docs-only skip on push

Previously both push and pull_request events used paths-ignore to skip
markdown/docs-only changes. The main branch ruleset requires the
`ci (ubuntu-latest)` and `ci (windows-latest)` contexts to pass before
merge — but paths-ignore meant those contexts never fire for docs-only
PRs, deadlocking the merge. We hit this on PR #33 (README sync) and
again now on PR #36 (changelog).

Drop paths-ignore from pull_request; keep it on push. PR CI always runs
so the required contexts resolve; post-merge push to main still skips
docs-only commits so we pay the CI cost at most once per docs-only change.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* docs(readme): drop PRs Welcome badge

Project is sole-maintainer and the badge linked to a CONTRIBUTING.md
that doesn't exist. Removing it trims a misleading signal from the
header badge row.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: RCellar <RCellar@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant