docs(web): document SlideTransition API#158
Open
1weiho wants to merge 2 commits into
Open
Conversation
Add a Reference page for the SlideTransition API introduced in #149 — schema, module-level vs per-page declaration, incoming-page-wins rule, the --osd-dir / data-osd-dir direction hook, design principles, the six-member tasteful family (rise / dissolve / settle / bloom / fall / breath), and anti-patterns. Cross-link from slide-meta: add a `transition` section and surface SlideTransition / TransitionPhase in the import block. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
WalkthroughThis PR adds comprehensive reference documentation for the SlideTransition feature, which enables opt-in per-page enter/exit animations powered by the Web Animations API. Updates include registering the new reference page, documenting the module-level transition export, and providing a full guide with examples and design guidance. ChangesSlide Transitions Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/web/content/docs/reference/meta.json`:
- Line 3: biome reported two issues: the project biome.json schema is outdated
and one lint rule can be auto-fixed; update the schema by running the biome
migration (run the recommended "biome migrate" to upgrade the schema version in
biome.json) and run the auto-fixer for lint issues (execute "pnpm check:fix") to
fix the useOptionalChain warning in packages/core/src/http/request-guard.ts so
the project passes biome checks without warnings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 78e0607a-525e-4fba-923d-fc7a11fd99ab
📒 Files selected for processing (3)
apps/web/content/docs/reference/meta.jsonapps/web/content/docs/reference/slide-meta.mdxapps/web/content/docs/reference/slide-transitions.mdx
| { | ||
| "title": "Reference", | ||
| "pages": ["config", "slide-meta", "image-placeholder", "locale"] | ||
| "pages": ["config", "slide-meta", "slide-transitions", "image-placeholder", "locale"] |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Locate pnpm check script
echo "== package.json scripts =="
cat package.json | sed -n '1,220p' | rg -n "\"check\"|\"check:fix\"|biome|eslint|prettier" || true
echo
echo "== Workspace scripts (if present) =="
ls -la
if [ -f apps/web/package.json ]; then
cat apps/web/package.json | sed -n '1,240p' | rg -n "\"check\"|\"check:fix\"|biome" || true
fi
echo
# 2) Attempt running pnpm check
echo "== Running: pnpm check =="
pnpm checkRepository: 1weiho/open-slide
Length of output: 4213
Biome check status for JSON meta.json
pnpm check(biome check .) was run and exited successfully (exit code 0), but reported warnings:biome.json: schema version mismatch (expected 2.4.15, found 2.4.12) — runbiome migrate.- FIXABLE lint:
packages/core/src/http/request-guard.ts(useOptionalChain) — runpnpm check:fix.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@apps/web/content/docs/reference/meta.json` at line 3, biome reported two
issues: the project biome.json schema is outdated and one lint rule can be
auto-fixed; update the schema by running the biome migration (run the
recommended "biome migrate" to upgrade the schema version in biome.json) and run
the auto-fixer for lint issues (execute "pnpm check:fix") to fix the
useOptionalChain warning in packages/core/src/http/request-guard.ts so the
project passes biome checks without warnings.
The Design principles section already states the positive form; the \xe2\x9d\x8c list read preachy in a reference doc. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Reference page for the
SlideTransitionAPI introduced in #149 so the public docs reflect what the runtime now ships.reference/slide-transitions.mdx— full schema (SlideTransition/TransitionPhase), module-level vs per-page declaration, the incoming-page-wins rule, the--osd-dir/data-osd-dirdirection hook, design principles, a six-member tasteful family (rise/dissolve/settle/bloom/fall/breath), and anti-patterns.reference/slide-meta.mdx— added atransition(optional) section pointing at the new page, and listedSlideTransition/TransitionPhasein the@open-slide/coreimport block.reference/meta.json— slottedslide-transitionsinto the sidebar betweenslide-metaandimage-placeholder.Why
Before this PR the only place the API was documented was the
slide-authoringagent skill. Users browsing opens-slide.dev/docs had no way to discover the feature or learn the keyframe contract.Notes for reviewers
image-placeholder,config).slide-authoringskill so framework docs and agent guidance don't drift.apps/webonly — no changeset (apps/web is private, not published).🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation