Skip to content

drt-hub/drt-web

Repository files navigation

drt-web

Source for the official drt website — landing page + docs, deployed to GitHub Pages.

Tool: drt-hub/drt · Package: drt-core · Install: pip install drt-core

Design principle — the repo is the single source of truth (SSoT)

The site is a view of drt-hub/drt, never a hand-maintained copy:

  • Connector matrix is generated from drt's own CLI (drt destinations|sources --format json) → data/.
  • Docs are pulled from drt's docs/ + README.mdsynced-docs/.
  • Version badge is read live from PyPI (drt-core).

These generated inputs are refreshed by .github/workflows/sync-from-drt.yml (weekly + on-demand + on a drt-updated dispatch from the drt repo). The sync opens a PR — nothing deploys until a maintainer reviews and merges it.

How updates flow

drt repo changes ──► sync-from-drt.yml ──► PR to drt-web ──► maintainer merges ──► deploy.yml ──► GitHub Pages
Muawiya design PR ──────────────────────► PR to drt-web ──► maintainer merges ──► deploy.yml ──► GitHub Pages

Every change — design or content — arrives as a PR a maintainer approves; merging to main auto-deploys. Approval == merge == deploy.

Layout

Path What
.github/workflows/deploy.yml Build (Docusaurus if package.json present, else the static placeholder) → publish to GitHub Pages
.github/workflows/sync-from-drt.yml Regenerate connector matrix + docs from drt → open a PR if changed
scripts/sync-from-drt.sh The generator (CLI JSON + sparse-checkout of docs/)
data/ Generated: destinations.json, sources.json, version.txt (do not edit by hand)
synced-docs/ Generated: drt's docs/ + README.md (do not edit by hand)
index.html Static placeholder served until the Docusaurus app lands

Status

🚧 Scaffold. The Docusaurus app (landing src/pages/ + docs theme) is being ported from the first-pass landing. Until then GitHub Pages serves index.html. When package.json lands, deploy.yml switches to the Docusaurus build automatically.

  • Hosting: GitHub Pages → https://drt-hub.github.io/drt-web/ (custom domain drthub.dev can be attached later — then set Docusaurus baseUrl from /drt-web/ to /).

Contributing the Docusaurus port

Open a PR adding the Docusaurus app at the repo root (package.json, docusaurus.config.js, src/pages/, docs/). Consume the generated inputs:

  • connector matrix → read data/destinations.json / data/sources.json
  • docs → source from synced-docs/
  • version badge → data/version.txt

Use baseUrl: '/drt-web/'. deploy.yml builds to ./build (Docusaurus default).

About

Official drt website — landing page + docs (GitHub Pages, generated from drt-hub/drt)

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors