Skip to content

docs: six verified reference gaps from user feedback #750

Description

@berry-13

Six smaller documentation gaps confirmed against the current librechat.yaml schema in packages/data-provider/src/config.ts. Each has a specific report behind it and a verifiable answer; none was large enough to justify guessing at in an automated pass.

1. skill_sync needs a worked array example

"An example would be nice how to construct the array correctly" — .../object_structure/skill_sync

The page describes the fields but does not show a complete, valid array entry. The shape is fully determined by skillSyncConfigSchema, so this is a mechanical addition once someone confirms which fields are realistic to show together. Note there is an open PR (#681) adding apiUrl for GitHub Enterprise, so this should land after or alongside it.

2. MCP over local HTTP has no tutorial

"need information for local mcp http connection tutorial" — /docs/features/mcp

mcp_servers.mdx documents the transports, and mcpSettings.allowedAddresses is documented for private hosts, but there is no start-to-finish walkthrough for a streamable-http server running on localhost or a Docker service name, which is the most common self-hosted case.

3. RAG API: supported file types and attachment scope

"Which file types are supported?" — /docs/features/rag_api

"the docs don't clearly say: does 'attached to conversation' mean THIS conversation only? or once attached, available across all future conversations? do you re-attach each time or not?" — /docs/configuration/rag_api

Both are answerable from fileConfig defaults and the file/association models, but the answer should be written by someone who can confirm the current agent-vs-conversation attachment semantics rather than inferred from schema alone.

4. Banner page has no screenshot

"What does the banner look like?" — /docs/configuration/banner

banner.mdx describes the CLI and the scheduling fields but never shows the rendered banner. Needs one screenshot from a running instance.

5. The YAML Validator does not say what it checks

"the server says the config doesnt work, then it doesnt matter that the yaml is valid" -- /docs/toolkit/yaml-validator

The reader's point is fair: a tool that reports "valid" while LibreChat still refuses the config is misleading unless it states its scope. The page should say explicitly what the validator does and does not verify (syntax versus the librechat.yaml schema), and point at docker compose logs api for the errors it cannot catch.

6. No guidance on where librechat.yaml lives in appliance installs

"Installing through truenas scale, where tf is the yaml supposed to be? your docs don't mention it, the app doesn't mention it, the dataset isn't declared in the settings." -- /docs/configuration/librechat_yaml

The page covers the plain Docker Compose and local layouts well, but says nothing about third-party app-catalogue installs (TrueNAS SCALE, Unraid, Portainer templates) where the reader does not own the compose file. Even a short note saying the file must be mounted to the path in CONFIG_PATH and that the mount has to be added through the appliance's own storage UI would unblock this.

Filed by the docs feedback automation. Discord feedback IDs: 1532628121629753353, 1536651156342972464, 1496586257227059214, 1513539238342164623, 1539946076935815169, 1511058954237509783, 1527467124203847732.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions