Developer docs

These docs are for maintainers and contributors working on the IvoryOS codebase, runtime behavior, tests, release notes, and documentation upkeep.

Start with Contributor setup if you are setting up a local checkout. Use Testing and verification before opening a merge request.

• Contributor setup
  • Python versions
  • Create an environment
  • Run the example platform
  • Local data
  • Useful environment variables
• Development workflow
  • Before changing code
  • Where changes usually belong
  • Changelog and docs
  • Pull request checklist
  • Generated docs pages
• Testing and verification
  • Unit and integration tests
  • Documentation build
  • Manual smoke test
  • Test ownership hints
  • When to add tests
• Architecture notes
  • System model
  • Main package areas
  • Change guidance
• Runtime walkthrough
  • Startup path
  • Interface generation
  • Workflow design path
  • Execution path
  • Direct-control path
• Extension points
  • Optimizers
  • Type conversion and form fields
  • Workflow runtime
  • Routes
  • Generated proxy
  • Plugins
  • Design agent
• Data model
  • Runtime directories
  • Database location
  • Workflow definition model
  • Execution records
  • Direct-control records
  • Interface schemas
  • Result files
• Architecture Decision Records
  • ADR 001: Runtime Design
  • ADR 002: Optimizer Schema
  • ADR 003: Remote Server Model
• IvoryOS routes docs
  • Homepage
  • Direct Control
  • Workflow Design
  • Workflow Library
  • Workflow Execution
  • Workflow Data
  • User Authentication
• Release notes
  • 1.6.3 (June 4th, 2026)
  • 1.6.2 (June 1st, 2026)
  • 1.6.1 (May 20th, 2026)
  • 1.6.0 (May 20th, 2026)
  • 1.5.21 (May 13th, 2026)
  • 1.5.20 (May 13th, 2026)
  • 1.5.19 (April 20th, 2026)
  • 1.5.18 (April 10th, 2026)
  • 1.5.17 (April 10th, 2026)
  • 1.5.16 (March 17th, 2026)
• IvoryOS major refactoring summary
  • Dissolving the monolithic utils/ directory
  • Real-time Socket.IO synchronization
  • Codebase cleanup
• Docs organization
  • Audience folders
  • Format
  • Canonical locations
  • External docs