Skip to content

docs: improve Screen Mirror documentation with detailed usage guide#2595

Closed
ruguoba wants to merge 1 commit into
slidevjs:mainfrom
ruguoba:docs/screen-mirror-documentation
Closed

docs: improve Screen Mirror documentation with detailed usage guide#2595
ruguoba wants to merge 1 commit into
slidevjs:mainfrom
ruguoba:docs/screen-mirror-documentation

Conversation

@ruguoba
Copy link
Copy Markdown

@ruguoba ruguoba commented May 12, 2026

Description

This PR significantly improves the Screen Mirror documentation to address the confusion raised in #2258. The current documentation is very brief and doesn't explain the feature's purpose, use cases, or limitations.

Changes

Enhanced Screen Mirror Documentation

  1. Added Use Cases Section

    • Live coding demos
    • Terminal output monitoring
    • External application mirroring
  2. Added Detailed Usage Guide

    • Step-by-step instructions
    • Keyboard shortcuts
    • Configuration options
  3. Added Important Notes Section

    • Clear explanation: Screen Mirror only shows in presenter view
    • Design rationale: Why it's designed this way
    • Alternative solutions: How to show content to audience
  4. Added Troubleshooting Section

    • Common issues and solutions
    • Performance optimization tips
    • Browser compatibility
  5. Added Best Practices

    • For live coding
    • For terminal demos
    • For general use
  6. Added Technical Details

    • How Screen Mirror works
    • Browser support table
    • Security considerations
  7. Added Examples

    • Live coding presentation example
    • Terminal demo example
  8. Added FAQ Section

    • Common questions and answers
    • Clarifies misconceptions

Why This Documentation Is Needed

Based on #2258, users are confused about:

  1. What Screen Mirror is for: Many users think it should show content to the audience
  2. How to use it properly: The current docs don't explain the workflow
  3. Why it only shows in presenter view: Users expect it to replace slide content

This documentation clearly explains:

  • Purpose: Screen Mirror is for the presenter to monitor another screen
  • Design: It only shows in presenter view by design
  • Alternatives: How to show content to the audience

Related Issues

Closes #2258

Testing

This is a documentation-only change. The documentation has been reviewed for accuracy based on the existing codebase and user feedback in #2258.


Key Point: This documentation makes it clear that Screen Mirror is for the presenter only and provides alternatives for showing content to the audience.

- Add comprehensive use cases and examples
- Explain why Screen Mirror only shows in presenter view
- Add troubleshooting section
- Add best practices and tips
- Add configuration options
- Add FAQ section

Addresses #2258
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for slidev ready!

Name Link
🔨 Latest commit 9bd34fe
🔍 Latest deploy log https://app.netlify.com/projects/slidev/deploys/6a03022ac9a9e10008be0c05
😎 Deploy Preview https://deploy-preview-2595--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.

@ruguoba ruguoba closed this by deleting the head repository May 13, 2026
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.

Document presenter screen mirroring usecase

1 participant