CyanPrintContributor Overview
Learn how to contribute to the CyanPrint platform
Contributing to CyanPrint
Welcome to the CyanPrint contributor documentation. This section is for developers who want to contribute to the CyanPrint platform itself.
How This Documentation is Organized
The contributor documentation is organized into three main areas:
Architecture
System architecture, component relationships, and execution flow
Repositories
Overview of all CyanPrint repositories and their purposes
Development
Setting up your development environment
CyanPrint Components
CyanPrint is built as a distributed system with several interconnected components:
| Component | Repository | Purpose |
|---|---|---|
| Iridium | sulfone.iridium | Command-line interface |
| Boron | sulfone.boron | Execution coordinator |
| Zinc | sulfone.zinc | Registry API |
| Argon | sulfone.argon | Registry Web UI (internally named "carbon") |
| Helium | sulfone.helium | SDKs (TypeScript, Python, C#) |
| Silicon | sulfone.silicon | Documentation site |
Getting Started
If you're new to contributing:
- Read the Architecture Overview to understand how CyanPrint works
- Set up your Development Environment
- Explore the Repositories to find where you want to contribute
Ways to Contribute
- Code contributions: Fix bugs, add features, or improve performance
- Documentation: Improve guides, tutorials, and API references
- Templates and processors: Create new templates or processors for the community
- Bug reports: Report issues you encounter while using CyanPrint
- Feature requests: Suggest new features or improvements