Skip to content

docs: add comprehensive documentation suite #46

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.

Sign up for GitHub

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

Open
sohw400 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add comprehensive documentation suite #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<!-- markdownlint-disable no-duplicate-header -->

<div align="center">
<img src="./assets/sentient-logo-narrow.png" alt="alt text" width="60%"/>
<img src="./assets/sentient-logo-narrow.png" alt="Sentient AGI Logo - OpenDeepSearch" width="60%"/>
</div>

<hr>
Expand Down Expand Up @@ -359,6 +359,15 @@ OpenDeepSearch is built on the shoulders of great open-source projects:
- **[LiteLLM](https://www.litellm.ai/)** 🔥 – Used for efficient AI model integration.
- **Various Open-Source Libraries** 📚 – Enhancing search and retrieval functionalities.

## 📚 Documentation

For detailed setup instructions and advanced usage:

- **[🔧 Detailed Setup Guide](docs/DETAILED_SETUP.md)** - Comprehensive installation and configuration
- **[💡 Usage Examples](docs/EXAMPLES.md)** - Real-world examples and use cases
- **[📚 API Reference](docs/API_REFERENCE.md)** - Complete API documentation
- **[🛠️ Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions

## Citation

If you use `OpenDeepSearch` in your works, please cite it using the following BibTex entry:
Expand Down
Loading