Skip to main content

ValkyrAI Documentation Overview

This document provides an overview of the ValkyrAI documentation structure and content. It serves as a guide to help you navigate the documentation and find the information you need.

Documentation Structure​

The ValkyrAI documentation is organized into the following sections:

Core Documentation​

Key Components​

  • Workflow Engine - Documentation for the ValkyrAI Workflow Engine
  • SecureFieldKMS - Documentation for the SecureField Key Management System
  • HeimdaLLM - Documentation for the HeimdaLLM AI component
  • GridHeim - Documentation for the GridHeim spreadsheet component
  • Model Context Protocol - Documentation for the Model Context Protocol implementation

Utilities​

  • Utilities Overview - An overview of the utilities included with ValkyrAI
  • VIDAR - Documentation for the VIDAR encrypted packaging utility

Developer Resources​

Documentation Content​

ValkyrAI Overview​

The ValkyrAI Overview provides a high-level introduction to ValkyrAI, including:

  • What ValkyrAI is and its purpose
  • Key features and capabilities
  • Architecture and components
  • Use cases and benefits

Getting Started​

The Getting Started guide helps you set up and start using ValkyrAI:

  • System requirements
  • Installation and setup
  • Creating your first ValkyrAI project
  • Basic usage and concepts

Workflow Engine​

The Workflow Engine documentation covers:

  • Architecture and components
  • Creating and managing workflows
  • Tasks and execution modules
  • API endpoints and usage
  • Integration with other ValkyrAI components

SecureFieldKMS​

The SecureFieldKMS documentation covers:

  • Overview and purpose
  • Key management
  • Encryption and decryption
  • Implementation details
  • Security considerations and best practices

HeimdaLLM​

The HeimdaLLM documentation covers:

  • Overview and purpose
  • Key features and capabilities
  • Integration with MindsDB
  • API endpoints and usage
  • Configuration and best practices

GridHeim​

The GridHeim documentation covers:

  • Overview and purpose
  • Spreadsheet functionality
  • REST API integration
  • Data model and API endpoints
  • Embedding capabilities
  • Security considerations and best practices

Model Context Protocol​

The Model Context Protocol documentation covers:

  • What MCP is and its purpose
  • ValkyrAI as an MCP consumer and publisher
  • MCP integration in ValkyrAI components
  • MCP server and client configuration
  • MCP roadmap and best practices

Utilities​

The Utilities Overview provides an introduction to the utilities included with ValkyrAI:

  • VIDAR encrypted packaging utility
  • vai command-line runner
  • list-to-file utility

The VIDAR documentation covers:

  • Overview and purpose
  • Key features
  • Usage and examples
  • Security considerations
  • Best practices

Developer's Guide​

The Developer's Guide provides comprehensive information for developers working with ValkyrAI:

  • Development workflow
  • OpenAPI specification enhancement
  • Code generation
  • Project setup
  • Versioning
  • Common issues and solutions

Troubleshooting Guide​

The Troubleshooting Guide addresses common issues you might encounter when working with ValkyrAI:

  • OpenAPI specification issues
  • SecureField and encryption issues
  • AspectJ weaving and runtime initialization failures
  • File contention and build process issues
  • Code generation and file overwrite issues
  • Naming conventions and reserved word conflicts
  • Database schema mismatches and data truncation
  • Inheritance and allOf issues in OpenAPI specifications
  • Missing generated files or obsolete references
  • Object properties and additionalProperties issues
  • Deployment and environment configuration errors
  • Spring Security ACL and DataObject interface issues
  • TypeScript code generation issues
  • Spring Framework dependency incompatibilities

How to Use This Documentation​

For New Users​

If you're new to ValkyrAI, we recommend starting with the following documents:

  1. ValkyrAI Overview - To understand what ValkyrAI is and what it can do
  2. Getting Started - To set up and start using ValkyrAI
  3. Developer's Guide - To learn about the development workflow

For Developers​

If you're a developer working with ValkyrAI, you might find the following documents most useful:

  1. Developer's Guide - For comprehensive development information
  2. Workflow Engine - To understand how to create and manage workflows
  3. SecureFieldKMS - To learn about secure data handling
  4. Troubleshooting Guide - For help with common issues

For System Administrators​

If you're responsible for deploying and maintaining ValkyrAI, you might find the following documents most useful:

  1. Getting Started - For installation and setup information
  2. SecureFieldKMS - For security considerations
  3. Utilities Overview - For information on utilities that can help with deployment and management

Contributing to the Documentation​

We welcome contributions to the ValkyrAI documentation! If you find errors, omissions, or have suggestions for improvements, please consider contributing.

To contribute to the documentation:

  1. Fork the ValkyrAI repository
  2. Make your changes to the documentation files
  3. Submit a pull request with your changes

Please ensure that your contributions follow our documentation style guide and are accurate and helpful.

Getting Help​

If you need help with ValkyrAI or have questions that aren't answered in the documentation, you can:

We're here to help you make the most of ValkyrAI!