VeritasVault Documentation Hub

Welcome to the official documentation repository for the VeritasVault.ai platform. This repository serves as the central knowledge base for all VeritasVault components, providing comprehensive documentation for developers, operators, and users.

🔍 Overview

This repository contains the source for our documentation portal built with Docusaurus, as well as our interactive demo documentation application. It aggregates and organizes documentation across all VeritasVault repositories:

• vv-chain-services - Blockchain integration and event processing services
• vv-infra - Infrastructure as Code and deployment configurations
• vv-gamification - Engagement and gamification systems
• vv-frontend - User interface and experience components

📚 Documentation Structure

Our documentation is organized into the following main sections:

docs/
├── getting-started/           # Onboarding and quickstart guides
├── architecture/              # System architecture and design decisions
├── chain-services/            # Documentation for vv-chain-services
├── infrastructure/            # Documentation for vv-infra
├── gamification/              # Documentation for vv-gamification
├── frontend/                  # Documentation for vv-frontend
├── integration/               # Cross-component integration guides
├── api-reference/            # API documentation
├── operations/               # Deployment and operations guides
├── tutorials/                # Step-by-step tutorials
└── contributing/             # Contribution guidelines

🛠️ Technologies

This documentation hub is built using:

• Docusaurus - Main documentation site framework
• Custom Demo App - Interactive documentation with live examples
• Mermaid - Diagrams as code
• Algolia DocSearch - Documentation search

🚀 Getting Started

Prerequisites

• Node.js (v16 or higher)
• Yarn (v1.22 or higher)
• Git

Local Development

1. Clone this repository:

   git clone https://github.com/veritasvault/vv-docs.git
   cd vv-docs

2. Install dependencies:

   yarn install

3. Start the development server:

   yarn start

4. Open your browser to http://localhost:3000

Building the Documentation

To build the static site:

yarn build

The built site will be in the build directory.

Running the Demo App

The demo app provides interactive examples of VeritasVault components:

cd demo-app
yarn install
yarn start

Open your browser to http://localhost:3001

🔄 Documentation Workflow

Automatic Updates

This repository automatically pulls documentation updates from other VeritasVault repositories through GitHub Actions workflows. When changes are made to documentation in component repositories, they are automatically synchronized to this documentation hub.

Manual Updates

For documentation specific to this hub or cross-cutting concerns:

1. Create a new branch:

   git checkout -b feature/new-documentation

2. Make your changes

3. Submit a pull request

📝 Contributing

We welcome contributions to improve our documentation! Please see CONTRIBUTING.md for guidelines.

Documentation Standards

• Use Markdown for all documentation
• Follow the Google Developer Documentation Style Guide
• Include code examples where appropriate
• Use Mermaid for diagrams
• Test all links and code examples

🏗️ Repository Structure

vv-docs/
├── .github/                  # GitHub Actions workflows
├── docs/                     # Documentation content
├── src/                      # Docusaurus custom components
├── static/                   # Static assets
├── demo-app/                 # Interactive documentation app
├── docusaurus.config.js      # Docusaurus configuration
├── sidebars.js               # Sidebar configuration
└── package.json              # Node.js dependencies

🔗 Integration with Component Repositories

Each component repository contains a docs/ directory with component-specific documentation. These are synchronized to this repository through the following mechanisms:

1. Automated Synchronization: GitHub Actions workflows pull documentation changes from component repositories
2. Documentation Links: Cross-references between documentation sections
3. Consistent Structure: Each repository follows the same documentation structure

🌐 Deployment

The documentation site is automatically deployed on changes to the main branch:

• Production: https://docs.veritasvault.ai
• Preview Builds: Generated for pull requests at unique URLs

🧰 Tools and Extensions

Recommended tools for documentation contributors:

• VS Code Extensions:

  • Markdown All in One
  • Markdown Preview Mermaid Support
  • Code Spell Checker
  • Markdown Lint

• Online Tools:

  • Excalidraw - For whiteboard-style diagrams
  • Carbon - For code screenshots
  • Tables Generator - For complex tables

📊 Documentation Analytics

We track documentation usage and feedback to continuously improve:

• Page views and time spent
• Search queries
• Documentation feedback ratings
• GitHub issues and pull requests

📞 Support

If you need help with the documentation or have suggestions:

• Open an issue
• Contact the documentation team at docs@veritasvault.ai
• Join our Discord community

📜 License

This documentation is licensed under CC BY-SA 4.0.