Skip to content

INDEX.md

Latest commit

 

History

History
102 lines (91 loc) · 5.72 KB

INDEX.md

File metadata and controls

102 lines (91 loc) · 5.72 KB
Raw

Rafiki Docs Index

Start with the README for install and everyday CLI usage. This index maps the deeper operating docs by surface area.

Product And System Shape

  • Scope - what belongs in Rafiki v1, what stays out of scope, and the boundaries for portal auth, Prompt Studio, MCP, and future extensions.
  • Folder Layout - where generated runs, registered assets, config, docs, prompts, and optional sibling repos live.
  • Roadmap - themes, phased work, verification gates, near-term execution order, and non-goals.
  • Model Policy - default model, provider choices, and Gemini versus OpenAI guidance.
  • Prompt And Media Release Policy - public package fixture, private prompt library handling, and media boundaries.
  • Keynote Visual Workflow Use Case - public use case for turning talk notes into prompt packs, reviewable image candidates, slides, and downstream publishing assets.

Runtime Surfaces

  • MCP - local MCP installation, tool surface, CLI bridge examples, and safety notes.
  • MCP Output Contract - proposed stable JSON envelope for typed tool outputs (paths, URLs, counts, errors, mutation flags).
  • AgentOpus MCP - hosted generative-video MCP (prompt/script → finished video); same lane as Rafiki/Floyo, not OpusClip clipping.
  • Floyo Video - drive Floyo (flowyo.ai) hosted-ComfyUI workflows to render short clips; dry-run-first CLI + MCP.
  • Doctor - what npm run doctor / npx rafiki --doctor checks, exit codes, and common fixes.
  • Chrome / Puppeteer - browser resolution and sandbox notes for rafiki --render.
  • Presentation Viewer - JSON-driven deck viewer, portable single-file mode, wrappers, schema, and content-series workflow.
  • Frontend Shell - TypeScript portal shell, Python proxy/API boundary, rollback routes, local build behavior, and verification commands.
  • Generate UI Next Work Plan - stabilization plan for the React generation workspace, dry-run safety, reference selection, and future job handling.
  • July 3 Issue-Crush Audit - open-issue disposition, close candidates, blocked issues, and recommended implementation order after Generate UI stabilization.
  • July 3 Closeout - merged PRs, stale branch cleanup proof, verification, and next work.
  • Portal Command Center - local portal spend summary, legacy rollback surfaces, feedback, evaluation, archive metadata state, revision staging, Curriculum Atlas surface, and API endpoints.
  • Spend Accounting - pricing profile semantics, estimate rules, and source-of-truth boundaries.

Registries, Archives, And Libraries

  • Command Center - aggregate every Rafiki image across all your repos into one dashboard (static library + live portal); registering external projects and the one-command refresh.
  • Library And Viewer Designer Handoff - current system map, archive inventory, diagrams, pain points, and redesign requirements for the image library, viewers, portal, registry, and media suite.
  • Asset Registry - registry schema, CLI indexing, and re-indexing guidance for external or generated assets.
  • Personal Media Suite - multimedia roots, Alex importer, local media registry, suite portal, and dry-run job commands.
  • Approved-Image Archive - approved-asset archive flow, layout, index.json schema, and storage location.
  • Library And Archive Roadmap - build plan for the all-runs image archive, portal curation, cleanup, and agent access.
  • Curriculum Atlas - local program/module/objective scaffold that links generated archive images to teaching surfaces.

Export, Deployment, And Delivery

  • BC + AI Builders Fellowship Reading Room Handoff - local launch-set inventory, selected variations, source provenance, QA evidence, and the public/private media boundary.
  • Canva Export - approved-image export layout and metadata enrichment for Canva handoff packages.
  • RAP Capstone Thumbnail And YouTube Handoff - V3 thumbnail package location, YouTube upload results, pending rate-limit retries, and missing-video follow-up.
  • Notion Export - Notion setup, export commands, idempotency, and database targeting.
  • Social-Post Expansion - platform constraints, source preference, environment requirements, and output format.
  • Deployment - static hosting setup, readiness checks, deploy commands, and caveats.
  • CDN Publishing Research - decision memo on optional CDN-backed approved-asset publishing (#202); recommends defer.
  • Delivery Pipeline - canonical agentic delivery contract: GitHub-only planning, labels, required issue shape, branch/PR traceability, pause controls, verification gates, and local commands.

Regeneration And Operator Workflows