Skip to content

docs: link the live docs site + README/diagram polish#75

Merged
kiyeonjeon21 merged 1 commit into
mainfrom
docs/live-docs-site-and-polish
Jun 21, 2026
Merged

docs: link the live docs site + README/diagram polish#75
kiyeonjeon21 merged 1 commit into
mainfrom
docs/live-docs-site-and-polish

Conversation

@kiyeonjeon21

Copy link
Copy Markdown
Owner

The Mintlify docs are now live at docs.reframe-video.com. This points the published surfaces at it and cleans up a few stale/rough spots.

Changes

  • README Documentation section — link the live site (docs.reframe-video.com)
  • packages/reframe-video/package.jsonhomepage → docs.reframe-video.com (npm "Repository" link still covers GitHub; takes effect on next publish)
  • docs/the-loop.mdx — ASCII flow → Mermaid (renders natively in Mintlify; README keeps ASCII since npm doesn't render Mermaid)
  • README — drop the stale "~1,700-token guide" figure (the printed eDSL guide is now ~10k tokens; the 33/33 first-attempt benchmark result stays)
  • README nits — "Two primitives back it" (path/motionPath no longer new) + the edit-survival opener now names beat name alongside node id / state / label

Notes

  • No release: docs/metadata only — reframe-video source and the plugin are untouched (no version bump). The homepage change reaches npmjs.com on the next publish.
  • The repo About → Website was set to docs.reframe-video.com separately (gh repo edit).

🤖 Generated with Claude Code

The Mintlify docs are now live at docs.reframe-video.com. Point the published
surfaces at it and clean up a few stale/rough spots.

- README Documentation section: link the live site (docs.reframe-video.com)
- packages/reframe-video/package.json: homepage -> docs.reframe-video.com
  (the npm "Repository" link still covers GitHub; takes effect next publish)
- docs/the-loop.mdx: ASCII flow -> Mermaid (renders natively in Mintlify; the
  README keeps ASCII since npm doesn't render Mermaid)
- README: drop the stale "~1,700-token guide" figure (the printed eDSL guide is
  now ~10k tokens; keep the 33/33 first-attempt benchmark result)
- README nits: "Two primitives back it" (path/motionPath no longer new), and the
  edit-survival opener now names beat name alongside node id / state / label

No release: docs/metadata only; reframe-video source and the plugin are untouched.
The repo About-website was set to docs.reframe-video.com separately.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 21, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
reframe 🟢 Ready View Preview Jun 21, 2026, 2:42 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@kiyeonjeon21 kiyeonjeon21 merged commit 4af6d7f into main Jun 21, 2026
2 checks passed
@kiyeonjeon21 kiyeonjeon21 deleted the docs/live-docs-site-and-polish branch June 21, 2026 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant