Skip to content

Commit a9691d3

Browse files
docs: update GitHub code links to reflect project restructure (#4287)
Update GitHub code reference URLs in FAQ and Pro documentation to match the new project structure. Changes plugin paths to crate paths and updates file locations for desktop app components. - Change plugins/listener paths to crates/listener-core - Update desktop app hook and service file paths - Fix recorder.rs path to recorder/mod.rs
1 parent d0e6368 commit a9691d3

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

apps/web/content/docs/faq/10.ai-models-and-privacy.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ When you start a recording session, Char spawns three actors in parallel:
5858

5959
Here is the session supervisor that orchestrates these actors:
6060

61-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/session/supervisor.rs#L56-L106" />
61+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/session/supervisor.rs#L56-L106" />
6262

6363
Audio is written to WAV files on your local disk. Here is the recorder handling incoming audio samples:
6464

65-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/recorder.rs#L130-L168" />
65+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/recorder/mod.rs#L130-L168" />
6666

6767
Audio files are stored at `{vault}/sessions/{session_id}/audio.wav` — they never leave your device unless you explicitly use cloud transcription.
6868

@@ -96,11 +96,11 @@ For local model details and download instructions, see [Local Models](/docs/deve
9696

9797
**Cloud models** send your audio to the selected provider for processing. Here is how the listener actor connects to your configured STT provider:
9898

99-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/listener/adapters.rs#L22-L102" />
99+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/listener/adapters.rs#L22-L102" />
100100

101101
The `ListenerArgs` passed to the STT adapter contain the following — this is all the data sent to the provider along with your audio stream:
102102

103-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/session/supervisor.rs#L122-L134" />
103+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/session/supervisor.rs#L122-L134" />
104104

105105
**What is sent:**
106106
- Your recorded audio (streamed in real-time or sent as a file for batch transcription)
@@ -140,15 +140,15 @@ When using cloud-based AI features, your session content is sent to the selected
140140

141141
Here is how the language model client is created — each provider connects directly to its own API:
142142

143-
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/hooks/useLLMConnection.ts#L230-L310" />
143+
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/ai/hooks/useLLMConnection.ts#L230-L310" />
144144

145145
When auto-enhance runs after a session ends, the enhanced result is stored locally:
146146

147-
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/hooks/autoEnhance/runner.ts#L82-L105" />
147+
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/store/tinybase/persister/session/save/note.ts#L39-L69" />
148148

149149
An analytics event is also fired when auto-enhance runs — it includes only the provider and model name, not the content:
150150

151-
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/hooks/autoEnhance/runner.ts#L161-L166" />
151+
<GithubCode url="https://github.com/fastrepl/char/blob/main/apps/desktop/src/services/enhancer/index.ts#L191-L197" />
152152

153153
**What is sent:**
154154
- Transcript text, raw notes, and prompt templates

apps/web/content/docs/pro/1.better-transcription.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ When using cloud transcription, your recorded audio is sent to the selected prov
7878

7979
Here is how Char selects the correct adapter for your configured provider — each provider has its own adapter that handles the audio stream:
8080

81-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/listener/adapters.rs#L22-L102" />
81+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/listener/adapters.rs#L22-L102" />
8282

8383
### What data is sent to the provider
8484

8585
**Sent alongside your audio stream:**
8686

87-
<GithubCode url="https://github.com/fastrepl/char/blob/main/plugins/listener/src/actors/session/supervisor.rs#L122-L134" />
87+
<GithubCode url="https://github.com/fastrepl/char/blob/main/crates/listener-core/src/actors/session/supervisor.rs#L122-L134" />
8888

8989
- Raw audio (Linear PCM, 16kHz sample rate, mono or stereo)
9090
- Configuration: model name, language codes, optional keyword boost list, sample rate, channel count

0 commit comments

Comments
 (0)