TPTheme Park APIsIndependent field notes
/
Writing docs
Start here

Writing docs

Add, organize, and publish Markdown pages from your local machine.

Create a .md file anywhere under content. Its folder and filename become the page URL: content/disney/wait-times.md is published at /disney/wait-times.

Begin each file with a small metadata block:

---
title: Wait times
description: Observed attraction wait-time fields and status behavior.
section: Disney
sectionOrder: 10
order: 3
---

sectionOrder controls where the sidebar section appears. order controls the page position inside that section.

Use a predictable structure so the notes remain useful months later:

  1. Scope and last-verified date
  2. Authentication or prerequisites
  3. Request shape
  4. Response fields
  5. Examples with secrets removed
  6. Edge cases and confidence level
  7. Change history

Preview and publish

Run npm run dev while writing to preview changes locally. When the pages are ready, run npm run deploy. The deploy command builds the site and publishes it to the configured Cloudflare Worker and custom domain.