rag-flex

Public
Plugin
Revisions
Back

docs / README.md

Developer Documentation

This directory contains technical documentation for RAG-Flex plugin developers.

πŸ“š Documentation Files

I18N.md | 繁體中文 | ζ—₯本θͺž

Internationalization System Guide

Comprehensive guide to the RAG-Flex internationalization (i18n) system (available in English, Traditional Chinese, and Japanese):

  • How the language detection system works
  • Supported languages and locale codes
  • Step-by-step guide for adding new languages
  • Translation file structure and guidelines
  • Testing and validation procedures

Read this if you want to:

  • Understand how multilingual support works
  • Add support for a new language
  • Modify or fix existing translations
  • Contribute to the i18n system

I18N_IMPLEMENTATION.md

Implementation Details

Technical implementation notes and design decisions:

  • Architecture overview
  • Code structure and module relationships
  • Implementation patterns and best practices
  • Known limitations and future improvements

Read this if you want to:

  • Understand the internal implementation
  • Make architectural changes to the i18n system
  • Debug complex translation issues

CHANGELOG_I18N.md

Internationalization Changelog

Version history of i18n system changes:

  • New language additions
  • Translation updates
  • Bug fixes and improvements
  • Breaking changes

Read this if you want to:

  • Track i18n feature history
  • Understand what changed between versions
  • Plan migration for breaking changes

SUMMARY.md

Project Summary

High-level overview of the project:

  • Key features and capabilities
  • Architecture summary
  • Development workflow

πŸ”— Related Documentation

🌍 Multilingual Versions

The main README is available in multiple languages:

πŸ“ Contributing

When adding new documentation:

  • Place files in this directory if they are:

    • Technical implementation details
    • Developer-focused guides
    • Architecture documentation
    • Changelogs for specific subsystems

  • Update this README to include:

    • File name and link
    • Brief description
    • Who should read it

  • Use clear naming:

    • Use descriptive names (e.g., AUTHENTICATION.md, not AUTH.md)
    • Use uppercase for top-level docs (e.g., I18N.md)
    • Use hyphens for multi-word names (e.g., API-DESIGN.md)

  • Link from main README when appropriate:

    • User-facing features should link from main README
    • Internal implementation details can stay here

πŸ“§ Questions?

For questions about: