enhanced docs #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manas95826
had a problem deploying
to
github-pages
GitHub Actions
Failure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes extensive updates to the documentation for the Empire Chain project, adding detailed guides and examples for various components and features. The most important changes include new sections on chatbots, cool features, agents, and tools, as well as updates to the main documentation structure and contributing guidelines.
New documentation sections:
docs/components/chatbots.md: Added detailed examples and usage instructions for different types of chatbots, including Simple Chatbot, Vision Chatbot, and PDF Chatbot.docs/components/cool_stuff.md: Introduced features like Data Visualization and Text to Podcast, with code examples and installation instructions.docs/components/empire_agent.md: Provided a comprehensive guide on using Empire Agent, including registering functions and processing queries.docs/components/phidata_agents.md: Detailed integration with PhiData for specialized agents like Web Agent and Finance Agent, including installation and usage examples.docs/components/tools.md: Described various utility tools, such as File Reader, Website Crawler, and Speech to Text, with examples and supported formats.Updates to main documentation:
docs/index.md: Updated the main documentation page to provide an overview of the features and installation instructions.docs/contributing.md: Added detailed guidelines for contributing to the project, including development setup, running tests, and code style.docs/license.md: Included the MIT License and third-party licenses for dependencies used in the project.mkdocs.yml: Updated the MkDocs configuration to enhance navigation, add new documentation sections, and include plugins for search and mermaid diagrams. [1] [2]