Skip to content

[Docs] Clarify installation instructions and KV backend options in README#1

Open
yJader wants to merge 1 commit into
Tele-AI:mainfrom
yJader:fix/docs-sync-current-code
Open

[Docs] Clarify installation instructions and KV backend options in README#1
yJader wants to merge 1 commit into
Tele-AI:mainfrom
yJader:fix/docs-sync-current-code

Conversation

@yJader

@yJader yJader commented Jul 7, 2026

Copy link
Copy Markdown

This pull request updates the README.md to clarify installation and launch instructions, and to update the default configuration documentation for backend selection. The most important changes are:

Documentation improvements:

  • Clarified the recommended way to run tests by specifying the full path to pytest within the TeleFuser virtual environment, ensuring consistency with the installation instructions.
  • Added a note explaining how the service launcher script resolves the Python interpreter, and how to override it if the repository layout differs.

Configuration documentation updates:

  • Changed the documented default for kv_store_type from fluxon to local_file, and clarified that local_file is the preferred backend for local use, while Fluxon is for distributed deployments.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant