Skip to content

docs(en): content issues in the English manual found during the Korean sync review #2297

Description

@Daeil-Jung

Automated review on #2296 (Korean docs sync) reported several content issues. The Korean text mirrors the English source, so the translation PR did not change them. This issue tracks the English-side fixes. The Korean pages need a re-sync after each fix.

English docs content issues

  1. docs/content/en/docs/contributing/index.md — Corepack prerequisite
    The page says Corepack "is included with recent Node.js releases". Corepack is not bundled with Node.js 25 and later. State that it ships with Node.js 24.x (the pinned version in .tool-versions) or document manual installation.

  2. docs/content/en/docs/contributing/index.mdupstream remote is used before it is defined
    The "If you have contributed before" section runs git pull upstream main --rebase, but the only git remote add upstream instruction appears later in the page. Add the remote setup (or a conditional check) before the update flow.

  3. docs/content/en/docs/manual/config/common.mdhttp:// guidance in the Base URL row
    The field guidance allows http:// without qualification. State that http:// is only for trusted local services and that remote providers require https://, because a remote HTTP endpoint exposes the API key and request data.

  4. docs/content/en/docs/manual/config/providers/consciousness/lm-studio.md — remote LM Studio setup is incomplete
    When AIRI and LM Studio run on different devices, the page only mentions CORS. Document Serve on Local Network or a non-loopback bind address, state that CORS provides neither reachability nor authentication, and warn against exposing the server publicly.

  5. docs/content/en/docs/manual/config/providers/transcription/comet-api.md — model selection does not match the UI
    The page says "Select an available transcription model", but the CometAPI transcription settings use a manual Model Name field. Instruct users to enter the exact model ID from the CometAPI catalog, for example whisper-1.

Related code-side finding

  1. Browser (Local) transcription provider appears although its settings page is a WIP placeholder
    browser-local-audio-transcription passes isBrowserAndMemoryEnough() on supported browsers, but its settings route renders only <WIP />. Both the English and Korean docs already mark the provider as unavailable; the provider metadata could hide it until the configuration page exists.

Source: CodeRabbit review on #2296.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingscope/documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions