Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add template and client configuration guide #510

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

oguzserdar
Copy link
Contributor

Overview

This PR adds comprehensive documentation for template and client configurations, helping users better understand and customize their character's behavior across different platforms.

Changes

  • Add new template and client configuration guide
  • Document all available template override options
  • Add client configuration settings for bot and DM handling
  • Include JSON examples for both templates and client configs
  • Add best practices section for configuration management

Testing

  • Verified all JSON examples are valid
  • Checked documentation formatting and structure
  • Ensured consistency with existing docs

Additional Notes

This documentation aims to make it easier for users to:

  • Override default prompt templates
  • Configure platform-specific behaviors

Add comprehensive documentation for template and client configurations:
- Document all available template override options
- Add client configuration settings for bot and DM handling
- Include JSON examples and best practices
- Add configuration guidelines for Discord, Telegram and Twitter clients

Part of the documentation improvement effort to help users better understand 
and customize their character's behavior across different platforms.
@jkbrooks jkbrooks merged commit f2dde70 into elizaOS:main Nov 22, 2024
2 checks passed
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.

3 participants