Skip to content

docs(skill): add content fit guidance#2638

Open
Jacobinwwey wants to merge 1 commit into
slidevjs:mainfrom
Jacobinwwey:docs/skill-layout-export-guidance
Open

docs(skill): add content fit guidance#2638
Jacobinwwey wants to merge 1 commit into
slidevjs:mainfrom
Jacobinwwey:docs/skill-layout-export-guidance

Conversation

@Jacobinwwey

Copy link
Copy Markdown

Title: Docs: Add content-fit guidance to the Slidev skill

1. Context & Motivation (Context)

  • Issue: N/A
  • Problem: The Slidev skill lists layout, Mermaid, transform, zoom, and code-scroll primitives independently, but it does not give agents a clear decision order for dense slides. That can lead agents to overuse whole-slide zoom or accept build-success as proof even when diagrams, tables, code, or text may overflow the visible canvas.
  • Trade-offs: This keeps the change as additive skill guidance instead of changing runtime layout behavior. The trade-off is that agents get better heuristics without deterministic engine-level enforcement; that avoids API/runtime risk and keeps the PR scoped to the skill content.

2. Implementation Details (Implementation)

  • Adds layout-content-fit.md as a dedicated reference for dense diagrams, tables, code, text, local transforms, slide zoom, and export verification.
  • Updates SKILL.md so agents treat it as an index and load task-specific references for dense slides, Mermaid diagrams, export behavior, and advanced Markdown syntax.
  • Cross-links layout-zoom, layout-transform, diagram-mermaid, and code-max-height to the content-fit workflow so the primitives are presented as complementary choices instead of isolated fixes.
  • Updates the skill README capability list to mention content-fit guidance.
  • Note: This PR intentionally does not change Slidev runtime, bundler, CLI behavior, or export output. Engine-level overflow detection would be a separate feature PR with tests.

3. Testing Strategies (Validation)

  • Added documentation-only coverage for skills/slidev/references/layout-content-fit.md and linked it from the relevant skill references.
  • Ran changed skill markdown link check for the modified skills/slidev files.
  • Ran pnpm lint.
  • Ran git diff --check.
  • Verified backward compatibility with existing skill references: the change is additive and does not remove or rename existing reference files.
  • Benchmark: N/A, docs-only skill guidance change.

Signed-off-by: Jacobinwwey <jacob.hxx.cn@outlook.com>
@netlify

netlify Bot commented Jun 19, 2026

Copy link
Copy Markdown

Deploy Preview for slidev ready!

Name Link
🔨 Latest commit f5eaac6
🔍 Latest deploy log https://app.netlify.com/projects/slidev/deploys/6a349ee2f7ae760008b80075
😎 Deploy Preview https://deploy-preview-2638--slidev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

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