derbyfish-gitdocs

DerbyFish documentation, synced to GitBook.

Structure

Each subdirectory maps to a GitBook space:

Directory
GitBook Space
Space ID
Visibility

home/

Home

7kEJXxucjmtwz2MsuBuU

Public

docs/

Documentation

PE6ni31rAWsIb35D8qgN

Public

api/

API Reference

WuhoeFGiENkMlkxkN7sj

Public

changelog/

Changelog

OaSdPaMrVM2OpHlHU64q

Public

help/

Help Center

pGDhw7l5Oem3rKe9mY7h

Public

internal/

Internal Docs

qNvo2PRqkaVyTjWv0kzK

Private

How It Works

  • Each space has its own README.md (landing page) and SUMMARY.md (sidebar nav)

  • GitBook syncs from this repo via git-sync (branch: main, projectDirectory per space)

  • Changelog entries are auto-generated by opsbot on PR merge

  • API docs are auto-generated weekly by GitHub Actions

Scripts

  • scripts/generate-api-docs.js — Scans derbyfish-web API routes and generates endpoint reference

  • .github/workflows/sync-api-docs.yml — Weekly API doc generation workflow

Last updated