trustgraph/docs/README.md
cybermaggedon 44bdd29f51
Update docs for API/CLI changes in 1.0 (#421)
* Update some API basics for the 0.23/1.0 API change
2025-07-03 14:58:32 +01:00

2.8 KiB

TrustGraph Documentation Index

Welcome to the TrustGraph documentation. This directory contains comprehensive guides for using TrustGraph's APIs and command-line tools.

Documentation Overview

📚 API Documentation

Complete reference for TrustGraph's APIs, including REST, WebSocket, Pulsar, and Python SDK interfaces. Learn how to integrate TrustGraph services into your applications.

🖥️ CLI Documentation

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

Step-by-step guide to get TrustGraph running using Docker Compose. Perfect for first-time users who want to quickly deploy and test TrustGraph.

Getting Started

If you're new to TrustGraph, we recommend starting with the Compose - Quick Start Guide to get a working system up and running quickly.

For developers integrating TrustGraph into applications, check out the API Documentation to understand the available interfaces.

For system administrators and power users, the CLI Documentation provides detailed information about all command-line tools.

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

Other deployment mechanisms include:

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