Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jan 28, 2026

Documentation changes

This PR includes multiple small edits to align with current state of the web editor.

Closes https://linear.app/mintlify/issue/DOC-239/editor-january-updates


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

Updates web editor documentation to reflect current features, streamline wording, and clarify workflows.

  • Expands Keyboard shortcuts with separate Visual/Markdown sections, new commands (e.g., open agent), and VS Code-style bindings
  • Reworks Live preview page: simplified open instructions (play icon, new tab), adds comparison table vs preview deployments
  • Revises Media page: focuses on supported types, adding media via drag-and-drop/slash command/asset manager, and managing assets (folders, rename, delete) with updated screenshots
  • Enhances Pages guide: clarifies filename search behavior; adds manage pages actions (move/duplicate/delete/hide)
  • Improves Publish flow: clarifies when publish creates PRs vs deploys directly and when the Publish button is disabled
  • Overview copy tightened and adds a card linking to Live preview

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

ethanpalm and others added 12 commits January 22, 2026 17:35
Restructure the keyboard shortcuts page to cover both Visual mode
and Markdown mode (Monaco editor). Visual mode shortcuts remain
unchanged. New Markdown mode section documents standard VS Code
shortcuts for find/replace, line manipulation, and multi-cursor
editing.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ethanpalm
Copy link
Collaborator Author

broken links are from images in the translated files. will be fixed when translations run

@ethanpalm ethanpalm merged commit 7d545c9 into main Jan 28, 2026
4 of 5 checks passed
@ethanpalm ethanpalm deleted the editor-jan-2026 branch January 28, 2026 03:28
|---------|--------------|-------------------|
| **Speed** | Instant | Requires build time |
| **Access** | In the editor | Shareable URL |
| **Use case** | View changes while editing | Share with team for review |
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor mismatch: this table says live preview access is "In the editor", but above you say it opens in a new tab.

Suggested change
| **Use case** | View changes while editing | Share with team for review |
| **Access** | In a new tab from the editor | Shareable URL |


To create a new folder, click **Add**.
Drag and drop media from your computer or the asset manager onto a page in visual mode. Files save to the root of your `images/` folder.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure we want to guarantee uploads always land in the root of images/ (users may have folders). Consider softening.

Suggested change
Drag and drop media from your computer or the asset manager onto a page in visual mode. Files save to your `images/` folder.

- Click pages to open them in the editor.
- Click the search icon or press <kbd>Cmd</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to search for files by name.
- Click the search icon or press <kbd>Cmd</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to search for files by filename. Search matches exact filenames, so use hyphens between words (for example, `get-agent-job` instead of `get agent job`).

Copy link
Contributor

Choose a reason for hiding this comment

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

"Search matches exact filenames" might be stricter than the actual behavior (and could go stale). If it isn't truly exact-match only, consider loosening the wording.

Suggested change
- Click the search icon or press <kbd>Cmd</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to search for files by filename. Search matches filenames, so use hyphens between words (for example, `get-agent-job` instead of `get agent job`).

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.

2 participants