Developers

The pages here will introduce you to the implementation and architectural aspects required to develop the origen core itself. Although geared more towards existing or future developers, users which want a more under-the-hood view of Origen will find this section interesting.

For future developers, please see the community contributions section for an overview of contributing to the core.

• Development Environment Setup
  • 1st Time Development Environment Setup
  • 1st Time Python App Setup
  • Regular Workflow
• Architecture Overview
  • Development APIs
  • APIs
• Documentation Generation Architecture
• Documenting The Core
  • Documentation Overview
  • Configured Extensions
  • Internal Referencing
  • External Referencing
  • Documenting The View (python/origen/origen)
  • Documenting The Controller (rust/pyapi)
  • Documenting The Model (rust/origen)
• Release Process
  • Goals
  • Command contract
  • Canonical release histories
  • Configuration
  • Tags
  • Transaction
  • GitHub Actions contract
  • Required tests
• Releasing Origen 2 and Origen Metal
  • Before starting
  • Previewing a release
  • Release types
  • Performing a release
  • Local preparation
  • Non-interactive operation
  • Monitoring and resuming a release
  • Verification