librechat-documentation

LibreChat Documentation Rules

Config Version Updates

When updating the LibreChat config version (e.g., from v1.2.6 to v1.2.7), follow these steps:

1. Create Changelog Files

Main Changelog File

Create: pages/changelog/config_v{VERSION}.mdx

Template:

---
date: YYYY/MM/DD
title: ⚙️ Config v{VERSION}
---

import { ChangelogHeader } from '@/components/changelog/ChangelogHeader'
import Content from '@/components/changelog/content/config_v{VERSION}.mdx'

<ChangelogHeader />

---

<Content />

Content File

Create: components/changelog/content/config_v{VERSION}.mdx

Format:

• Use bullet points starting with -
• Group related changes together
• Include links to detailed documentation using [Feature Name](/docs/configuration/librechat_yaml/object_structure/{feature})
• Describe what was added/changed and its purpose
• Keep descriptions concise but informative

Example:

- Added `memory` configuration to control memory functionality for conversations
  - Configure memory persistence and personalization settings
  - Set token limits and message window sizes for memory context
  - Configure agents for memory processing with provider-specific settings
  - Supports both predefined agents (by ID) and custom agent configurations
  - See [Memory Configuration](/docs/configuration/librechat_yaml/object_structure/memory) for details

2. Create Object Structure Documentation

For new root-level configurations, create: pages/docs/configuration/librechat_yaml/object_structure/{feature}.mdx

Structure:

1. Title: # {Feature} Configuration
2. Overview: Brief description of the feature
3. Example: Complete YAML example showing all options
4. Field Documentation: Use <OptionTable> components for each field
5. Subsections: For complex nested objects
6. Notes: Important considerations at the end

3. Update Navigation

Add the new feature to: pages/docs/configuration/librechat_yaml/object_structure/_meta.ts