Skip to content

README improvements for integrators and developers - #23

Merged
ikusteu merged 2 commits into
mainfrom
docs/readme-improvements
Nov 20, 2026
Merged

ikusteu merged 2 commits into
mainfrom
docs/readme-improvements

Conversation

@silviot

@silviot silviot commented Nov 19, 2026

Copy link
Copy Markdown
Member

The README now opens with an in-call screenshot and the steps a participant takes to start captions. A deployment table lists prerequisites and engine options. An architecture diagram traces audio from Talk through recognition and back to the sidebar, with links to the relevant code.

The compatibility section explains the bookmarklet requirement on Nextcloud 33–35 and distinguishes declared support from the documented browser-call check on Nextcloud 34. It links to the Talk team's provider-selection PR and clarifies that the proposed change covers native captions while the scrollable sidebar still uses the bookmarklet.

Verified the relative links, section anchors and screenshot path. git diff --check passed.

@ikusteu
ikusteu merged commit 593a99f into main Nov 20, 2026
11 checks passed
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.

2 participants