This repository contains the official documentation for the Talking 3D Character Service Snippets. The purpose of this repository is to provide users with comprehensive guides, code examples, and resources to effectively integrate and use the available snippets with the Talking 3D Character Service.
For the full documentation, visit our docs.
The snippets-docs repository is dedicated exclusively to documentation for the Talking 3D Character Service Snippets. Here, you will find everything you need to understand how to use the snippets, including:
- Getting Started: Initial setup and installation instructions.
- Usage Guides: Examples of how to use different snippets with the Talking 3D Character Service.
- API Reference: A detailed guide to the available API methods and configuration options.
- Troubleshooting: Solutions to common issues users may encounter.
This repository aims to provide clear and concise documentation for both new and advanced users of the service snippets.
We welcome contributions from the community! If you would like to help improve the documentation, please follow the steps below:
- Fork this repository.
- Clone your fork locally:
git clone https://github.com/yourusername/snippets-docs.git
- Create a new branch for your changes:
git checkout -b feature-or-fix-name
- Make your changes to the documentation.
- Ensure your changes are clear, concise, and helpful for users.
- Commit your changes:
git commit -m "Brief description of the change" - Push your changes to your fork:
git push origin feature-or-fix-name
- Create a Pull Request on GitHub from your fork to the
mainbranch of thesnippets-docsrepository.
Once you open a pull request, it will be reviewed by the documentation maintainers. Feedback will be provided, and once approved, the changes will be merged into the repository.
(For snippets staff)
Once the changes have been made, to deploy to production on github pages run:
make deploy
If you run into github issues subprocess.CalledProcessError: Command '['git', 'push', 'origin', 'gh-pages', '--force']' returned non-zero exit status 128.
Then install gh with sudo apt install gh then run
gh auth login and login with SSH. maybe https will work too.
This documentation is licensed under the MIT License. See the LICENSE file for more details.
If you have any questions about the documentation or encounter issues while contributing, please feel free to open an issue in the GitHub Issues section of this repository.
For any other inquiries or support requests, you can also contact us directly at [lewis@snippets3d.com] or via discord at [https://discord.com/invite/U8UEUhm6Bn].