docs: user manual — tutorial walkthrough + digest-video example + troubleshooting#72
Merged
Merged
Conversation
…roubleshooting The README covered install/config/command-reference but had no narrated end-to-end walkthrough, no worked digest-video example, and no troubleshooting. - docs/tutorial.md — zero-to-wiki walkthrough (sync → vocab/enrich/topics → media/describe → digest-video → dashboard), with expected output per step. - docs/digest-video.md — worked example (prereqs, run, the "## Video digest" note shape, model selection, video selection). - docs/troubleshooting.md — FAQ: expired X session, the re-saw-0 tripwire, rate limits, parakeet/ffmpeg PATH (incl. cron/launchd minimal-PATH), digest-video slowness/timeouts, silent-video "sin voz", iCloud generate hang, API keys. - README: link the three from Documentation + a "New to XBrain?" pointer at Quick start. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had install/config/command-reference but no narrated walkthrough, no worked digest-video example, and no troubleshooting. Adds a proper user manual under
docs/:## Video digestnote shape, per-run model selection, video selection.sin voz, iCloudgeneratehang, API keys.Docs-only.