Instruction file imported from debabratahazra/rag_pipeline (.github/instructions/documentation.instructions.md). Copyright stays with the author.

rag_pipeline documentation conventions

Principles

• Link, don't duplicate: reference other files with Markdown links instead of copying their content. Keep README.md (user-facing) and AGENTS.md (agent/contributor-facing) complementary, not redundant.
• Minimal and actionable: every line should help a user or AI agent; trim filler.
• Match the code: read the relevant module before documenting it; verify CLI commands and API samples are real.

Project specifics

• Preserve the offline-first framing: the project runs with no API keys, and provider extras are optional. Don't imply a key is required.
• Use Windows / PowerShell-friendly command examples (this repo is developed on Windows), e.g. .\.venv\Scripts\Activate.ps1.
• When a new loader/provider/format is added, update the README usage/format table, .env.example (new keys), and the touched module's docstring.

Don't

• Don't edit program logic from a docs task — Markdown, comments, and docstrings only.