Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
*~
_site/
review.txt*
.#*
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ GEM
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.12.2)
json (2.16.0)
just-the-docs (0.10.1)
jekyll (>= 3.8.5)
jekyll-include-cache
Expand Down
636 changes: 636 additions & 0 deletions REFACTOR.md

Large diffs are not rendered by default.

14 changes: 10 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ url: "https://docs.trustgraph.ai"
plugins:
- jekyll-sitemap

aux_links:
Template Repository: https://github.com/just-the-docs/just-the-docs-template

# logo: "/assets/images/just-the-docs.png"
# favicon_ico: "/assets/images/favicon.ico"

Expand Down Expand Up @@ -70,7 +67,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/trustgraph-ai/trustgraph-ai.github.io"
gh_edit_repository: "https://github.com/trustgraph-ai/docs.trustgraph.ai"
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
Expand All @@ -82,6 +79,9 @@ callouts:
warning:
title: Warning
color: red
wip:
title: Work in Progress
color: yellow

# Exclude files and directories from Jekyll build
exclude:
Expand All @@ -91,3 +91,9 @@ exclude:
- .github/
- README.md

defaults:
- scope:
path: ""
values:
layout: page

11 changes: 11 additions & 0 deletions _includes/todo-banner.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% if page.todo %}
<blockquote class="wip">
<p><strong>🚧 This page needs work</strong></p>
<p>
{% if page.todo_notes %}
Note:
{{ page.todo_notes }}
{% endif %}
</p>
</blockquote>
{% endif %}
7 changes: 7 additions & 0 deletions _layouts/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: default
---

{% include todo-banner.html %}

{{ content }}
6 changes: 4 additions & 2 deletions advanced/backup-restore.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Backup & Restore
layout: default
parent: Advanced Topics
grand_parent: TrustGraph Documentation
todo: true
todo_notes: This page is a placeholder and needs content to be added
review_date: 2026-02-01
---

# Backup & Restore

FIXME: Coming soon

This page will contain procedures for backing up and restoring TrustGraph data and configurations.
This page will contain procedures for backing up and restoring TrustGraph data and configurations.
6 changes: 4 additions & 2 deletions advanced/clustering.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Clustering
layout: default
parent: Advanced Topics
grand_parent: TrustGraph Documentation
todo: true
todo_notes: This page is a placeholder and needs content to be added
review_date: 2026-02-01
---

# Clustering

FIXME: Coming soon

This page will contain guides for setting up multi-node clustering configurations in TrustGraph.
This page will contain guides for setting up multi-node clustering configurations in TrustGraph.
6 changes: 4 additions & 2 deletions advanced/custom-algorithms.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Custom Algorithms
layout: default
parent: Advanced Topics
grand_parent: TrustGraph Documentation
todo: true
todo_notes: This page is a placeholder and needs content to be added
review_date: 2026-02-01
---

# Custom Algorithms

FIXME: Coming soon

This page will contain guides for developing custom algorithms and extending TrustGraph's analytical capabilities.
This page will contain guides for developing custom algorithms and extending TrustGraph's analytical capabilities.
6 changes: 4 additions & 2 deletions advanced/disaster-recovery.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Disaster Recovery
layout: default
parent: Advanced Topics
grand_parent: TrustGraph Documentation
todo: true
todo_notes: This page is a placeholder and needs content to be added
review_date: 2026-02-01
---

# Disaster Recovery

FIXME: Coming soon

This page will contain disaster recovery planning and procedures for TrustGraph systems.
This page will contain disaster recovery planning and procedures for TrustGraph systems.
6 changes: 4 additions & 2 deletions advanced/extending-trustgraph.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Extending TrustGraph
layout: default
parent: Advanced Topics
grand_parent: TrustGraph Documentation
todo: true
todo_notes: This page is a placeholder and needs content to be added
review_date: 2026-02-01
---

# Extending TrustGraph

FIXME: Coming soon

This page will contain guides for creating custom extensions and plugins for TrustGraph.
This page will contain guides for creating custom extensions and plugins for TrustGraph.
216 changes: 205 additions & 11 deletions advanced/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,220 @@
---
title: Advanced Topics
layout: default
nav_order: 11
has_children: true
parent: TrustGraph Documentation
review_date: 2026-02-01
---

# Advanced Topics

Advanced configuration, performance tuning, and extending TrustGraph.
**Deep dives into performance, clustering, and customization**

## Advanced Topics
## What's in This Section?

This section covers **advanced operational topics** for users who need to optimize performance, scale to multiple nodes, customize algorithms, or extend TrustGraph's functionality.

- **[Custom Algorithms](custom-algorithms)** - Developing custom algorithms
- **[Performance Tuning](performance-tuning)** - Optimization techniques
- **[Clustering](clustering)** - Multi-node clustering setup
- **[Backup & Restore](backup-restore)** - Data backup and recovery
- **[Disaster Recovery](disaster-recovery)** - Disaster recovery planning
- **[Extending TrustGraph](extending-trustgraph)** - Custom extensions and plugins
### This Section is For:
- **Performance engineers** optimizing TrustGraph deployments
- **Platform architects** designing large-scale systems
- **Advanced operators** managing complex deployments
- **Developers** building custom extensions

### Not What You Need?
- **Just getting started?** → Begin with [Getting Started](../getting-started/)
- **Deploying for first time?** → See [Deployment](../deployment/)
- **Learning the basics?** → Read [Overview](../overview/)

## Prerequisites

These topics assume familiarity with TrustGraph basics. Review [Getting Started](../getting-started/) first.
Before diving into advanced topics:

✅ **You should have**:
- Successfully deployed TrustGraph (see [Getting Started](../getting-started/))
- Basic understanding of TrustGraph architecture (see [Overview](../overview/))
- Completed at least one workflow (see [How-to Guides](../guides/))

⚠️ **These topics assume**:
- Familiarity with distributed systems
- Knowledge of Kubernetes (for clustering topics)
- Understanding of performance profiling
- Experience with system administration

## Advanced Topics

{: .wip }
> **Work in Progress**
> Most advanced topics are planned for future releases. Check back or contribute!

### [Extending TrustGraph](extending-trustgraph)
**Build custom functionality** - Develop custom processors, algorithms, and plugins.

{: .wip }
> Planned content includes:
> - Custom processor development
> - Plugin architecture
> - Service extension patterns
> - Integration hooks

**When you need this**: Building custom extraction logic, integrating proprietary systems, or adding new capabilities.

### [Performance Tuning](performance-tuning)
**Optimize for speed and throughput** - Techniques for improving TrustGraph performance.

{: .wip }
> Planned content includes:
> - Resource allocation tuning
> - Query optimization
> - Batch processing configuration
> - Caching strategies
> - Database tuning

**When you need this**: Processing large document sets, handling high query volumes, or optimizing resource usage.

### [Clustering](clustering)
**Multi-node deployment** - Scale TrustGraph across multiple nodes for high availability and load distribution.

{: .wip }
> Planned content includes:
> - Multi-node architecture
> - Load balancing
> - Service distribution
> - State management
> - Failover configuration

**When you need this**: Scaling beyond single-node capacity, achieving high availability, or distributing workload.

### [Backup & Restore](backup-restore)
**Data protection** - Strategies for backing up and restoring TrustGraph data.

{: .wip }
> Planned content includes:
> - Backup strategies
> - Data export/import
> - Point-in-time recovery
> - Incremental backups
> - Backup automation

**When you need this**: Protecting production data, migrating between environments, or disaster recovery planning.

### [Disaster Recovery](disaster-recovery)
**Business continuity** - Planning and implementing disaster recovery for TrustGraph.

{: .wip }
> Planned content includes:
> - DR strategy planning
> - RTO/RPO considerations
> - Failover procedures
> - Recovery testing
> - Geo-redundancy

**When you need this**: Production deployments requiring business continuity guarantees.

### [Custom Algorithms](custom-algorithms)
**Algorithm development** - Implementing custom entity extraction and relationship discovery algorithms.

{: .wip }
> Planned content includes:
> - Algorithm development framework
> - Entity extraction customization
> - Relationship discovery
> - Custom ranking algorithms
> - Integration with TrustGraph pipeline

**When you need this**: Domain-specific extraction requirements or specialized knowledge graph construction.

## Topic Roadmap

### Available Now
Currently, most advanced topics are in planning. The community welcomes contributions!

### Coming Soon
- **Performance Tuning** basics
- **Extending TrustGraph** patterns
- **Backup & Restore** procedures

### Future Plans
- Complete clustering guide
- Disaster recovery playbooks
- Custom algorithm development
- Advanced monitoring
- Multi-region deployment

## When to Use Advanced Topics

### Start Here If...

| Your Situation | Relevant Topic |
|----------------|----------------|
| TrustGraph is too slow | [Performance Tuning](performance-tuning) |
| Need high availability | [Clustering](clustering) |
| Building custom features | [Extending TrustGraph](extending-trustgraph) |
| Planning for failures | [Disaster Recovery](disaster-recovery) |
| Need data backups | [Backup & Restore](backup-restore) |
| Domain-specific extraction | [Custom Algorithms](custom-algorithms) |

### Don't Start Here If...

- ❌ You haven't deployed TrustGraph yet → [Getting Started](../getting-started/)
- ❌ You don't understand basic concepts → [Overview](../overview/)
- ❌ You're looking for common tasks → [How-to Guides](../guides/)
- ❌ You need API documentation → [Reference](../reference/)

## Contributing to Advanced Topics

Many advanced topics are currently placeholders. We welcome contributions from the community!

**How to contribute**:
1. Review [Contributing Guidelines](../contributing/contributing)
2. Check existing content and identify gaps
3. Share your expertise with the community
4. Submit pull requests with documentation

**Especially valuable**:
- Real-world performance tuning experiences
- Clustering deployment lessons learned
- Custom extension examples
- Backup/restore procedures you've tested

## Getting Help with Advanced Topics

### Community Resources
- **Discord** - Ask advanced questions in community channels
- **GitHub Discussions** - Share your use cases and solutions
- **GitHub Issues** - Report advanced configuration issues

### Documentation
- **[Troubleshooting](../deployment/troubleshooting)** - Operational issues
- **[Reference](../reference/)** - Technical specifications
- **[Examples](../examples/)** - Working code samples

### Professional Support
For enterprise deployments needing advanced configurations, consider:
- Community consulting partnerships
- Contributing your requirements to the roadmap
- Participating in working groups

## Next Steps

### Not Finding What You Need?

1. **Check if it's in another section**:
- [How-to Guides](../guides/) for task instructions
- [Reference](../reference/) for technical specs
- [Deployment](../deployment/) for setup guides

2. **Search the documentation** (Ctrl+K)

3. **Ask the community**:
- [Getting Help](../contributing/getting-help)
- Discord community
- GitHub Discussions

4. **Contribute**:
- Share your advanced use cases
- Document your solutions
- Help build these guides

---

Coming soon - advanced configuration and extension guides!
**Have advanced TrustGraph experience?** We'd love your contributions! See [Contributing](../contributing/) to get started.
Loading