Skip to content

Latest commit

 

History

History

docs

Folders and files

README.md

Gitpay Worker documentation

Jekyll site for GitHub Pages, structured like Stripe’s docs:

  • Guides — how the worker works (architecture, auth, versioning)
  • API Reference — endpoint docs with cURL, linked back to guides
  • OpenAPI — live FastAPI schema (/docs, /redoc, /openapi.json)

Local preview

bundle install
bundle exec jekyll serve

Open http://127.0.0.1:4000/gitpay-worker/ (see baseurl in _config.yml).

Deploy

Pushes to main that change docs/ trigger .github/workflows/docs.yml.