Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Dec 17, 2025

Documentation changes

This PR documents recent editor features.

  • Share previews from the editor
  • Publishing workflow based on branch protection rules

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Documents branch-protection–aware publishing behavior and adds preview sharing instructions with screenshots in the editor guide.

  • Editor guide updates:
    • Publishing workflow:
      • Rewrite to explain behavior based on branch type and branch protection.
      • Add comparison table of outcomes and a tip linking to GitHub/GitLab branch protection docs.
    • Share preview deployments:
      • New subsection with steps and screenshots to share preview URLs.
      • Note on public accessibility and option to enable preview authentication.
    • Copy tweak: Overview step updated to say you can publish directly or open a pull request.

Written by Cursor Bugbot for commit e8c2743. This will update automatically on new commits. Configure here.

Comment on lines +337 to +343
1. Click the **Share** button in the editor toolbar.
1. Click the **Preview** button to open the preview deployment in a new browser tab.
<Frame>
<img src="/images/editor/share-preview-light.png" alt="Share preview panel opened in the editor toolbar." className="block dark:hidden" />
<img src="/images/editor/share-preview-dark.png" alt="Share preview panel opened in the editor toolbar." className="hidden dark:block" />
</Frame>
1. Share the preview URL with anyone who needs to review your changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these numbers be 1, 2, 3 instead of 1, 1, 1?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They'll still render as 1, 2, 3 and then you don't have to worry about counting if you change how many items are in the list.

@ethanpalm ethanpalm merged commit e676798 into main Dec 17, 2025
5 checks passed
@ethanpalm ethanpalm deleted the editor-workflows-and-share branch December 17, 2025 02:57
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.

3 participants