Skip to content

Appendices

Reference documentation and supplementary material

This section contains reference material to supplement the main documentation:

Available Appendices

Glossary

Complete terminology reference with definitions, examples, and cross-references for all Groggy concepts.

What's inside: - 50+ terms with clear definitions - Code examples for key concepts - Common abbreviations - Quick reference tables

Use this when: You need to understand terminology or look up unfamiliar concepts.

Design Decisions (ADRs)

Architectural Decision Records documenting the key design choices made in Groggy.

What's inside: - 11 major architectural decisions - Rationale and alternatives considered - Consequences and trade-offs - Design principles summary

Use this when: You want to understand why Groggy works the way it does.

Performance Cookbook

Practical optimization patterns and recipes for high-performance graph operations.

What's inside: - 11 optimization recipes - Performance anti-patterns to avoid - Profiling and benchmarking tools - Complexity guidelines by graph size

Use this when: You need to optimize your graph operations or debug performance issues.

Temporal Extensions Guide

Comprehensive guide to temporal graph analytics and time-series features in Groggy.

What's inside: - Core temporal concepts (snapshots, index, scope, deltas) - Common temporal analysis patterns - Best practices and performance optimization - Example use cases and code - Troubleshooting guide

Use this when: You need to analyze graph evolution, track changes over time, or perform temporal queries.

By Topic

Learning Groggy: - Start with the Glossary to understand terminology - Read Design Decisions to understand the architecture - Refer to Performance Cookbook for optimization - See Temporal Extensions Guide for time-series analysis

Understanding Architecture: - Design Decisions - Why these choices? - Glossary - What do terms mean? - Concepts: Architecture - How does it work?

Optimizing Performance: - Performance Cookbook - Optimization recipes - Performance Guide - Comprehensive tutorial - Design Decisions - Performance trade-offs

Temporal Analysis: - Temporal Extensions Guide - Complete temporal features guide - User Guides - Basic graph operations - API Reference - Temporal API methods

Reference Material

All appendices are designed as quick reference guides. They complement the main documentation:

Using the Appendices

Glossary

Best for: Looking up unfamiliar terms, understanding concepts

Example use:

"What's the difference between a Subgraph and a SubgraphArray?" → Look it up in the Glossary

Design Decisions

Best for: Understanding architectural choices, learning the "why"

Example use:

"Why does Groggy use columnar storage?" → Read ADR-003 in Design Decisions

Performance Cookbook

Best for: Optimizing code, debugging performance issues

Example use:

"My graph filtering is slow. How do I speed it up?" → Check Recipe 1 in Performance Cookbook

Temporal Extensions Guide

Best for: Working with temporal data, analyzing graph evolution

Example use:

"How do I query the graph as it was last week?" → Check the Time-Travel Queries pattern in Temporal Extensions Guide

Contributing

Found an issue or have a suggestion?

These appendices are living documents. They're updated as Groggy evolves.