Getting Started with CPS

Welcome to CPS!

Everything you need to integrate with the Convention Photography System
View as Markdown

This repository contains the documentation for the Convention Photography System (CPS). It includes the CPS API specification to demonstrate how the system provides event photo management, browsing, and ordering capabilities.

The CPS consists of two main platforms:

  • photos.conventionphotography.com - Photo gallery and browsing system
  • convention.photos - Customer ordering and checkout system

Use this documentation to understand and integrate with the CPS APIs.

What’s included

This documentation contains everything you need to understand the CPS:

docs.yml# Configures navigation, theme, and hosting
fern.config.json# Sets your organization name and CLI version
openapi.yaml# CPS API specification
docs
pages# Markdown content for the documentation
assets# Logos, favicon, and other assets

Getting started with CPS

1

Browse Events

Use the Get All Events endpoint to retrieve available convention events.

$GET https://photos.conventionphotography.com/event
2

View Event Photos

Fetch photos from a specific event with pagination.

$GET https://photos.conventionphotography.com/event/ASDAR26?page=1&limit=50
3

Place an Order

Browse photos, add to cart, validate address, and create order via convention.photos.

$POST https://convention.photos/api/validate-address
$POST https://convention.photos/api/orders
4

Track Orders

Monitor order status and submit feedback.

$POST https://convention.photos/api/orders/{orderId}/feedback

When you’re ready to go live:

$fern generate --docs

Next steps

The CPS API specification is already included. Update the Markdown pages with your content, and customize the theme to match your brand. For detailed guidance, explore the pages in this documentation or visit the Fern documentation.

Edit your docs

Learn how to preview and publish changes using the CLI or Fern Editor

Set up navigation

Configure tabs, sections, and pages in your docs.yml file

Customize your docs

Brand your documentation with colors, logos, and layouts

API reference

See how Fern generates interactive API documentation