From 7f0cdbfa1a05186fab2b7128b98d1827a05b3b31 Mon Sep 17 00:00:00 2001 From: Ilenia Date: Wed, 1 Jul 2026 14:49:06 +0200 Subject: [PATCH] docs: refresh eclaire docs and version badge --- src/components/navigation.ts | 2 +- src/content/docs/projects/eclaire.md | 34 +++++++++++++--------------- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/src/components/navigation.ts b/src/components/navigation.ts index a419128..36e3062 100644 --- a/src/components/navigation.ts +++ b/src/components/navigation.ts @@ -673,7 +673,7 @@ export const navigation = [ { label: "Eclaire", link: "/projects/eclaire", - badge: { text: "v1.0.0", variant: "tip" }, + badge: { text: "v1.1.0", variant: "tip" }, }, { label: "freeCodeCamp Review Generator", diff --git a/src/content/docs/projects/eclaire.md b/src/content/docs/projects/eclaire.md index 617f953..793a79a 100644 --- a/src/content/docs/projects/eclaire.md +++ b/src/content/docs/projects/eclaire.md @@ -10,13 +10,13 @@ This section is for those interacting with a live instance of the Application. ### Getting Started -1. **Initial Setup**: Navigate to the Configuration page to set up your API credentials and language preferences. +1. **Initial Setup**: Open the configuration screen and provide your API credentials and language preferences. 2. **Configuration Options**: - - **Deepgram API Key**: Required for speech-to-text transcription. You must provide your own API key from [Deepgram](https://deepgram.com). - - **Translation Service API Key**: Required for text translation. A demo key is available with a 10 requests/minute rate limit, or you can provide your own key. - - **Source Language**: Select from 12 supported languages (English, German, Dutch, Swedish, Danish, Spanish, French, Portuguese, Italian, Turkish, Norwegian, Indonesian). - - **Target Language**: Select from 60+ supported languages for translation. + - **Deepgram API Key**: Required for speech-to-text transcription. + - **Translation Service API Key**: Required for text translation. The application includes a built-in demonstration key in source comments with a 10 requests/minute limit. + - **Source Language**: Selected from the source-language allow-list defined in the configuration component. + - **Target Language**: Selected from the language-code mapping list used by the configuration component. 3. **Using the Translation Interface**: - Navigate to the Agent page to begin translation. @@ -43,10 +43,9 @@ The application automatically enables: ### Limitations -- Source language is limited to 12 languages supported by Deepgram -- Translation service demo key has a rate limit of 10 requests/minute -- Requires modern browser with microphone access -- WebSocket connection required for real-time functionality +- Requires a modern browser with microphone access. +- Requires a WebSocket connection for real-time transcription. +- Translation demo key usage is rate limited. ## 2. Technical Documentation @@ -70,17 +69,17 @@ This section is for those interested in running their own instance of the Applic 2. Install dependencies: ```bash - npm install + pnpm install ``` 3. Start the development server: ```bash - npm run dev + pnpm run dev ``` 4. Build for production: ```bash - npm run build + pnpm run build ``` ### Technology Stack @@ -88,7 +87,7 @@ This section is for those interested in running their own instance of the Applic **Frontend Framework:** - Angular 19.1.4 with standalone components - TypeScript 5.7.3 -- RxJS 7.8.1 for reactive programming +- RxJS 7.8.2 for reactive programming - Angular Reactive Forms for configuration management **External APIs:** @@ -144,8 +143,7 @@ This section is for those interested in running their own instance of the Applic #### Routing -- `/` - Redirects to home -- `/home` - Landing page +- `/` - Home page - `/config` - Configuration page - `/agent` - Translation interface @@ -192,9 +190,9 @@ POST request body: #### Available Scripts -- `npm run dev` - Start development server -- `npm run lint` - Run ESLint with zero warnings policy -- `npm run build` - Build for production +- `pnpm run dev` - Start development server +- `pnpm run lint` - Run ESLint with zero warnings policy +- `pnpm run build` - Build for production #### Code Quality