***

title: Welcome to CPS!
subtitle: Everything you need to integrate with the Convention Photography System
slug: welcome
-------------

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:

<Files>
  <File name="docs.yml" comment="Configures navigation, theme, and hosting" />

  <File name="fern.config.json" comment="Sets your organization name and CLI version" />

  <File name="openapi.yaml" comment="CPS API specification" />

  <Folder name="docs" defaultOpen>
    <Folder name="pages" comment="Markdown content for the documentation" />

    <Folder name="assets" comment="Logos, favicon, and other assets" />
  </Folder>
</Files>

## Getting started with CPS

<Steps>
  <Step title="Browse Events">
    Use the `Get All Events` endpoint to retrieve available convention events.

    ```bash
    GET https://photos.conventionphotography.com/event
    ```
  </Step>

  <Step title="View Event Photos">
    Fetch photos from a specific event with pagination.

    ```bash
    GET https://photos.conventionphotography.com/event/ASDAR26?page=1&limit=50
    ```
  </Step>

  <Step title="Place an Order">
    Browse photos, add to cart, validate address, and create order via convention.photos.

    ```bash
    POST https://convention.photos/api/validate-address
    POST https://convention.photos/api/orders
    ```
  </Step>

  <Step title="Track Orders">
    Monitor order status and submit feedback.

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

    When you're ready to go live:

    ```bash
    fern generate --docs
    ```
  </Step>
</Steps>

## 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](https://buildwithfern.com/learn).

<CardGroup cols={2}>
  <Card title="Edit your docs" icon="duotone pen-to-square" href="/editing-your-docs">
    Learn how to preview and publish changes using the CLI or Fern Editor
  </Card>

  <Card title="Set up navigation" icon="duotone sitemap" href="/navigation">
    Configure tabs, sections, and pages in your docs.yml file
  </Card>

  <Card title="Customize your docs" icon="duotone palette" href="/customization">
    Brand your documentation with colors, logos, and layouts
  </Card>

  <Card title="API reference" icon="duotone code" href="/api-reference">
    See how Fern generates interactive API documentation
  </Card>
</CardGroup>