Documentation Changelog

This changelog tracks significant updates to OpenIndustrial documentation. For product changes, see the product release notes.

---

January 2026

2026-01-19 - Track 5 Complete: Polish & Reference

Added:

• Complete troubleshooting section

  • Troubleshooting Index - Landing page with quick links
  • Common Issues - Error messages and fixes
  • FAQ - Frequently asked questions
  • By-symptom guides: No Data, Empty Queries, Connection Issues
  • By-component guides: Connections, Surfaces, Warm Queries

• Complete reference section

  • Reference Overview - API documentation hub
  • REST API Reference - Complete endpoint documentation
  • GraphQL Reference - Schema and query examples
  • Glossary - All terminology defined

• Documentation changelog (this page)

Changed:

• Navigation updated with Troubleshooting and Reference sections

---

2026-01-19 - Track 4 Complete: Vision Migration

Added:

• Complete vision section

  • Vision Overview - Philosophy and roadmap entry point
  • Manifesto - Category declaration
  • Execution Model - Architecture behind the Control Plane
  • Why OpenIndustrial - Problem/solution analysis
  • Mission Critical - Independence and de-risk proof
  • Reflex Memory - Future capability: memory-first control
  • Open Autonomy - Brand hierarchy

• Roadmap section

  • Roadmap Overview - What's shipped vs. coming
  • Schema Promotion - In development
  • Autonomous Actions - Planned

Changed:

• Moved visionary content from main docs to /vision/
• Clear separation between "today" and "tomorrow" content
• MCP Integration moved from roadmap to shipped (documented in Quickstart)

---

2026-01-18 - Track 3 Complete: Journeys & Patterns

Added:

• Industry journey documentation

  • Pharma Journey - Complete pharmaceutical use case
  • Energy and Manufacturing journey placeholders

• Pattern library

  • Common implementation patterns
  • Best practices by industry

Changed:

• Updated 6-step flow to 7-step flow (added MCP connection step)
• MCP documentation moved from roadmap to foundation

---

2026-01-17 - Track 2 Complete: Self-Service Guides

Added:

• Complete guide library (34 guides)
  • Connections guides - Data source setup
  • Surfaces guides - Workspace configuration
  • Warm Queries guides - Query building
  • MCP guides - AI integration
  • API guides - Programmatic access
  • Team guides - Collaboration features

Changed:

• Task-oriented structure (problem → solution)
• Every guide includes "Ask Azi" section

---

2026-01-15 - Track 1 Complete: Foundation

Added:

• Complete Quickstart flow (6 steps)

  • Quickstart Overview
  • Create Data Connection
  • Get Data Flowing
  • Connect to Surface
  • Build Query with Azi
  • Use Your API
  • Connect Any AI - The "aha moment"

• Meet Azi section

  • Azi Overview
  • You Stay in Control

• Landing page updates

Changed:

• Documentation framing: "Here's what you can do today" (not "here's our vision")
• Governed AI positioning throughout

---

Documentation Principles

1. Practical first - Show what works today before discussing vision
2. Task-oriented - Organized by what users want to accomplish
3. Governed AI framing - Azi proposes, you decide
4. Clear status labels - Distinguish shipped from roadmap
5. AI-ready - Self-contained sections for AI retrieval

---

Contributing

Documentation is maintained by the OpenIndustrial team. To report issues or suggest improvements:

1. Use the feedback link on any page
2. Describe what's unclear or missing
3. We review feedback weekly

---

Related

• Vision & Roadmap - Where we're heading
• Quickstart - Get started in 10 minutes
• Reference - Technical documentation