apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-04-25 08:26:21 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add AsyncAPI spec for websocket (#613)

Browse source 
* AsyncAPI for websocket docs

* Delete old docs

* Update docs/README.md to point to docs site

* Add generated API docs
This commit is contained in:
cybermaggedon 2026-01-15 11:57:16 +00:00 • committed by GitHub
parent fce43ae035
commit 8a17375603
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
110 changed files with 8325 additions and 23324 deletions
Download patch file Download diff file Expand all files Collapse all files

60
docs/README.md
View file

@ -1,59 +1,21 @@
# TrustGraph Documentation Index
# TrustGraph Documentation
Welcome to the TrustGraph documentation. This directory contains comprehensive guides for using TrustGraph's APIs and command-line tools.
Welcome to TrustGraph! For comprehensive documentation, please visit:
## Documentation Overview
## 📖 [https://docs.trustgraph.ai](https://docs.trustgraph.ai)
### 📚 [API Documentation](apis/README.md)
Complete reference for TrustGraph's APIs, including REST, WebSocket, Pulsar, and Python SDK interfaces. Learn how to integrate TrustGraph services into your applications.
The main documentation site includes:
### 🖥️ [CLI Documentation](cli/README.md)
Comprehensive guide to TrustGraph's command-line interface. Includes detailed documentation for all CLI commands, from system administration to knowledge graph management.
### 🚀 [Quick Start Guide](README.quickstart-docker-compose.md)
Step-by-step guide to get TrustGraph running using Docker Compose. Perfect for first-time users who want to quickly deploy and test TrustGraph.
- **[Overview](https://docs.trustgraph.ai/overview)** - Introduction to TrustGraph concepts and architecture
- **[Guides](https://docs.trustgraph.ai/guides)** - Step-by-step tutorials and how-to guides
- **[Deployment](https://docs.trustgraph.ai/deployment)** - Deployment options and configuration
- **[Reference](https://docs.trustgraph.ai/reference)** - API specifications and CLI documentation
## Getting Started
If you're new to TrustGraph, we recommend starting with the
[Compose - Quick Start Guide](README.quickstart-docker-compose.md)
to get a working system up and running quickly.
**New to TrustGraph?** Start with the [Overview](https://docs.trustgraph.ai/overview) to understand the system.
For developers integrating TrustGraph into applications, check out the
[API Documentation](apis/README.md) to understand the available interfaces.
**Ready to deploy?** Check out the [Deployment Guide](https://docs.trustgraph.ai/deployment).
For system administrators and power users, the
[CLI Documentation](cli/README.md) provides detailed information about all
command-line tools.
**Integrating with code?** See the [API Reference](https://docs.trustgraph.ai/reference) for REST, WebSocket, and SDK documentation.
## Ways to deploy
If you haven't deployed TrustGraph before, the 'compose' deployment
mentioned above is going to be the least commitment of setting things up:
See [Quick Start Guide](README.quickstart-docker-compose.md)
Other deployment mechanisms include:
- [Scaleway Kubernetes deployment using Pulumi](https://github.com/trustgraph-ai/pulumi-trustgraph-scaleway)
- [Intel Gaudi and GPU](https://github.com/trustgraph-ai/trustgraph-tiber-cloud) - tested on Intel Tiber cloud
- [Azure Kubernetes deployment using Pulumi](https://github.com/trustgraph-ai/pulumi-trustgraph-aks)
- [AWS EC2 single instance deployment using Pulumi](https://github.com/trustgraph-ai/pulumi-trustgraph-ec2)
- [GCP GKE cloud deployment using Pulumi](https://github.com/trustgraph-ai/pulumi-trustgraph-gke)
- [RKE Kubernetes on AWS deployment using Pulumi](https://github.com/trustgraph-ai/pulumi-trustgraph-aws-rke)
- It should be possible to deploy on AWS EKS, but we haven't been able to
script anything reliable so far.
## Support
For questions, issues, or contributions:
- **GitHub Issues**: Report bugs and feature requests
- **Documentation**: This documentation covers most use cases
- **Community**: Join discussions and share experiences
## Related Resources
- [TrustGraph GitHub Repository](https://github.com/trustgraph-ai/trustgraph)
- [Docker Hub Images](https://hub.docker.com/u/trustgraph)
- [Example Notebooks](https://github.com/trustgraph-ai/example-notebooks) -
shows some example use of various APIs.