Skip to content

Docs Pipeline

Date: 2026-07-11 Status: Active Product: DAY · Site: https://dayprotocol.com · Docs: https://docs.dayprotocol.com Repos: protocol /root/projects/day · docs site /root/projects/autoyield-docs → GitHub dayprotocol/docs


IDTopicSource of truth (day repo)Public MDX slug
****Product constitutionthe private monorepo/constitution/
****Architecturethe private monorepo (canonical) · the private monorepo (rails inventory)/architecture/
****Versioning strategythe private monorepo/versioning/
****Copyright & licensingthe private monorepo/copyright/
****Agent APIthe private monorepo/agent-api/
****Deployed package IDs (Sui · Solana · Base · Arb)the private monorepo/package-ids/
****This pipelinethe private monorepo/pipeline/

Supporting public pages (same pipeline, not numbered):

TopicSourceSlug
Fee modelthe private monorepo/fee-model/
Vaultsthe private monorepo/vaults/
Auto Yield featurethe private monorepo/auto-yield/
Phase 1 homesthe private monorepo/phase-1/
Open corethe private monorepo/open-core/
Launch surfacethe private monorepo + rebrand/launch/
Enablementthe private monorepo/enablement/

Internal / research docs (Superform deep-dives, ticket maps, smoke logs) stay in the day repo only — not auto-imported unless explicitly promoted.


UseDo not use (public)
DAY (product)Open Yield as product name
dayprotocol.comopenyield.pro as primary
docs.dayprotocol.comdocs.openyield.pro as primary
Auto Yield / Auto Pay / Vaults = features of DAYSeparate product brands
Fee 500 bps on yieldInvented APY / fee on deposit

Legacy hosts may still reverse-proxy old Open Yield URLs; copy must say DAY.


1. Edit markdown in day/docs/ (authority for protocol truth)
2. IF API surface/auth/paths/examples changed → update OpenAPI SAME CHANGE:
- api/routes-manifest.mjs (paths + auth)
- runtime/config/openapi.mjs (ENDPOINT_DOCS enrichment)
- docs/02-agent-api.md (integrator human reference)
- Starlight: autoyield-docs src/content/docs/api-reference.mdx + index.mdx
3. Gate: cd /root/projects/day && npm run check:docs-openapi
(fails if docs/OpenAPI/manifest drift)
4. Import / sync into dayprotocol/docs MDX (autoyield-docs checkout)
5. npm run build # Astro Starlight + llms.txt
6. rsync dist/ → box (deploy-docs-to-box.sh runs the gate first)
7. Deploy API if OpenAPI generator changed so GET /openapi.json is live
8. Commit day by path; commit+push dayprotocol/docs

HARD RULE — docs and OpenAPI never diverge

Section titled “HARD RULE — docs and OpenAPI never diverge”
When you change…You MUST also…
Route path or authroutes-manifest.mjs + OpenAPI + 02-agent-api.md
Request/response exampleENDPOINT_DOCS in openapi.mjs + human docs
Auth model / strategyId / feesOpenAPI info/x-day + getting-started + api-reference
Starlight public pagesRe-run gate; keep examples matching X-API-Key
Terminal window
# Always before docs deploy / merge
cd /root/projects/day
npm run check:docs-openapi
npm run test:docs-openapi
Terminal window
# From day repo — required gate
cd /root/projects/day
npm run check:docs-openapi
# From docs site repo
cd /root/projects/autoyield-docs
npm ci
npm run import:day # sync from /root/projects/day/docs
npm run build
./scripts/deploy-docs-to-box.sh # runs day check:docs-openapi first
  • Primary: root@178.156.146.226:/srv/dayprotocol/docs/
  • Legacy mirror: root@178.156.146.226:/srv/autoyield/docs/

Each public pack page must:

  1. Brand — product name DAY, not Open Yield
  2. Authority — link constitution when stating invariants
  3. Honest numbers — fee 500 bps; missing APY → N/A
  4. No secrets — no Infisical paths, private keys, or prod signer details
  5. Versioned schemas — cite *.v1 names where API/plans appear
  6. Package ids — live multi-chain ids from / GET /api/day/packages (never invent)

Build emits:

  • /llms.txt — page index
  • /llms-full.txt — full text dump for agents

Regenerated by scripts/generate-llms.mjs after astro build.


  • …07 sources exist under day/docs/
  • Starlight pages live at docs.dayprotocol.com for each pack id
  • No “Open Yield” product branding on public pages
  • Package IDs page lists live Sui · Solana · Base · Arbitrum ids (no secrets)
  • Deploy path documented + scripted

day/docs is source of truth. The docs site is a curated, branded publish of the public pack — not a second constitution. Promote deliberately; keep research and ticket logs private to the monorepo.