Turn a recording into a document

Create the document

1. Open your recording.
2. Below the player, click the Auto docs tab.
3. Click Create documentation.

Shoyu reads the transcript, the recording’s context and its comments. The document opens with a Summary of the whole recording, then chapters with a frame from the video, the code and terminal commands it shows, links such as Figma files and Linear issues, a Discussion line, and follow-ups from the comments. Each item has its time in the recording: click it to play from there. Parts of the recording you skipped in Studio are left out.

Discussion counts the comments you can see and the people who wrote them, sorts them into problems, questions, decisions, suggestions and kind words, and gives the overall mood: Mostly positive, Mixed, Mostly concerns or Neutral.

Keep it up to date

When someone comments with something that changes the story, such as a bug, a correction or a question, the tab says New comments may change this documentation and Shoyu writes a new version a minute or two later. If you reply that you will look into a problem, the follow-up says Author is on it. Resolving the thread marks it Resolved.

To write it again now, click Update now. The current version stays readable until the new one is ready.

See the code

When you can read the repository, the lines the recording points at load in the document by themselves, with syntax highlighting. Shoyu reads them as you and never stores them. Otherwise you see the repository, file and lines as a link to open on GitHub or GitLab.

Shoyu can read the code when your organization has connected GitHub in Settings › Policy and you have linked your GitHub account, or when you have added your own token. See Show code from your own repositories.

Show code from your own repositories

1. Create a read-only token. On GitHub, open Settings › Developer settings › Fine-grained tokens, choose the repositories and give Contents read-only access. On GitLab, open Preferences › Access tokens and add a token with the read_api scope.
2. In Shoyu, open Account, then Connected apps.
3. Under Source code access, paste the token beside GitHub token or GitLab token, and click Save.

Shoyu checks the token with GitHub or GitLab before saving it, keeps it encrypted, and uses it only to read code you open. To stop, click Remove, and revoke the token on GitHub or GitLab too.

Copy or share it

• Click Copy Markdown to paste the document anywhere that reads Markdown.
• Click Share, then GitHub issue, to open a new issue with the document filled in. Shoyu offers the repositories the recording’s Code context names, or you can type one.
• Click Share, then Linear issue, to open a new Linear issue with the document filled in.
• Click Share, then Notion page. Shoyu copies the document and opens a new Notion page: paste it in.
• Click Share, then Download Markdown, to save it as a file.

Nothing is posted until you submit it in GitHub, Linear or Notion. Frames in a copied document link back to Shoyu, so only people who can watch the recording see them.

Document a playlist

1. Open the playlist from Videos › Playlists.
2. Click Documentation.
3. Each recording shows where it stands. Click Create on your own recordings that have no document, or Create all to do them together. For someone else’s recording, click Ask author for auto doc.
4. Click Copy Markdown or Download Markdown to get every recording’s document, in playlist order, as one file.

When you ask an author, they get a note in their Inbox. You can ask once per recording.

Choose which recordings get one automatically

Owners and admins can change Auto documentation in Settings › Policy. Turn off Allow Auto documentation to hide every document and stop new ones; they come back when you turn it on. Under Create automatically for recordings by, pick owners, admins or members. Under And for recordings tagged, add tags: a recording that gets one of them is documented without its owner asking.