Skip to main content

Guidebook of the Realm of Valkyr

A concise, hierarchical guide for LLMs and humans to navigate Valkyr’s code, documentation, and web platforms.

1. Introduction​

This guidebook maps out:

  • Core code modules and their responsibilities
  • Website pages, routes, and components
  • Key documentation and support links
  • How subsystems interact

Use it as a one-stop reference for “where to find X” and “how Y relates to Z.”

2. Core Modules & Services​

  1. thorapi (Java Spring OpenAPI codegen)

    • Path: thorapi/
    • Contains OpenAPI specs (src/main/resources/openapi/*.yaml)
    • Generates REST controllers, models, repos under generated/
    • Primary for: API definitions, Java & TypeScript SDKs

  2. valkyrai (AI Backend)

    • Path: valkyrai/
    • Spring Boot app, LLM orchestration via LLMController.java
    • Config in src/main/resources/application.yaml
    • Docs: valkyrai/docs/ (ACL fixes, security, compliance)

  3. web/typescript/valkyr_labs_com (Public Website)

    • Path: web/typescript/valkyr_labs_com/
    • React/Next front-end using ThorAPI SDK (src/thorapi/)
    • Components: src/components/ (Home, DynamicPricing, etc.)
    • Docs: Docusaurus-style in docs/docs/Products/ThorAPI/Component Library

  4. gridheim (Legacy XLS/Developer guide)

    • Path: gridheim/
    • Developer guide: openxls-developers-guide.md

  5. docker/ (Containers & Dev Harness)

    • Subfolders:
      • docker/local-harness/ – local dev compose
      • docker/thorapi-runner/ – codegen runner
      • docker/valkyrai/ – AI service container
      • docker/mindsdb/ – ML integration

  6. ValorIDE_docs/ (Agent Memory Bank)

    • Paths: activeContext.md, techContext.md...
    • Stores design decisions, progress, ADRs

3. Website Routes & Navigation​

React Router Paths (from src/App.tsx)​

  • / → Home
  • /roi-calculator → ROICalculator
  • /landingpage → LandingPage
  • /features → Features
  • /workflowtable → WorkflowTable
  • /subscribers → AllMembers
  • /about → About
  • /contact-us → ContactUs
  • /sign-up → Signup
  • /signup → WhitePaperForm
  • /login → Login
  • /forgot-password → ForgotPassword
  • /reset-password → ResetPassword
  • /valoride → ValorIDE
  • /visualizer → OpenAPIViz
  • /workflow/builder → WorkflowBuilderReactFlow
  • /vai → Vai
  • /thorapi → ThorAPI
  • /valkyrai → ValkyrAI
  • /openxls → OpenXLS
  • /valor → Valor
  • /fun → Funnel
  • /content-reader/:contentDataId → ContentReader
  • /library → LibrarySection
  • /user/:principalId → UserDetail
  • /workflow-designer/:workflowId → WorkflowDesignerPage
  • /dashboard → SixDDashboard
  • /app-dashboard → Dashboard
  • /userlist → UserManagement
  • /applications → ApplicationList
  • /hosting → HostingControls
  • /hosting/templates → HostInstanceTemplates
  • /application-detail/:applicationId → ApplicationDetail
  • /data-workbook → DataWorkbook
  • /contentlist → ContentList
  • /partner-program → LandingPartnerProgram
  • /application-editor → ApplicationEditorPage
  • /oas-editor → OpenAPIEditor
  • /openapi-designer → OpenAPIDesigner
  • /openapi-designer/:specId → OpenAPIDesigner
  • /openapi-workbench → OpenAPIWorkbench
  • /openapi-workbench/:specId → OpenAPIWorkbench
  • /admin/ops → AdminWorkflowOps
  • /agents → AgentsHub
  • /funnel/cxo → Cxo
  • /funnel/cxofunnel → CxOFunnel
  • /funnel/funnel-page → FunnelPage
  • /funnel/reseller → Reseller
  • /funnel/solo → Solo
  • /funnel/startup → Startup
  • /funnel/team → Team
  • /funnel/white-paper → WhitePaper
  • /funnel/thank-you → ThankYou
  • /cxo → LandingCxO
  • /pro → LandingPro
  • /team → LandingTeam
  • /open → LandingFOSS
  • /oldpricing → Pricing (legacy)
  • /pricing → DynamicPricing
  • /crm/* → CRM App (nested routes)

Products

  • ThorAPI: /thorapi
  • CRM: /crm
  • Hosting: /hosting
  • Pricing ROI Calculator: /roi-calculator
  • Valor IDE: /valoride
  • ValkyrAI: /valkyrai
  • OpenXLS: /openxls

Resources

Key Pages & Components​

  • Home

    • File: src/website/Home.tsx
    • Landing overview, feature highlights

  • Dynamic Pricing

    • File: src/website/DynamicPricing.tsx
    • Interactive demo of pricing engine

  • Component Library

    • Docs: docs/docs/Products/ThorAPI/Component Library
    • Source: src/components/

4. Documentation & Support Links​

  • Project READMEs

    • Top-level: README.md
    • thorapi/README.md
    • web/typescript/backend/README.md

  • Product Docs

    • ThorAPI: docs/docs/Products/ThorAPI/
    • ValkyrAI: docs/docs/Products/ValkyrAI/launch/

  • Internal Dev Guides

    • valkyrai/docs/ (ACL, security)
    • gridheim/openxls-developers-guide.md

  • Docker Guides

    • docker/local-harness/README.md
    • docker/lambda/README.md
    • docker/mindsdb/README.md

  • Memory Bank & ADRs

    • ValorIDE_docs/
    • docs/adr/

5. Relationships & Workflows​

  1. API Spec → thorapi

    • OpenAPI YAML → codegen → Java & TS models/services

  2. Backend (valkyrai)

    • Spring Boot uses generated repos/services for ACL & LLM calls

  3. Frontend (valkyr_labs_com)

    • RTK Query hooks auto-generated from ThorAPI spec
    • UI components import from @thorapi/model & @thorapi/redux/services

  4. Testing

    • Unit tests under web/typescript/test/ for UI
    • Integration tests via Spring Boot test suites in valkyrai/src/test/java

  5. Dev & Deployment

    • Local harness: docker/local-harness/
    • CI builds: Maven in pom.xml, Yarn for TS

6. Quick-Start Paths​

  • API spec editing: 
    cd thorapi/ && mvn clean package
  • Backend run: 
    cd valkyrai/ && mvn spring-boot:run
  • Frontend run: 
    cd web/typescript/valkyr_labs_com/ && yarn start
  • Local Docker stack: 
    docker/local-harness/dev-up.sh

End of Guidebook