Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jun 18, 2025

Documentation changes

This PR updates https://mintlify.com/docs/editor to help people less familiar with Git start using the web editor while learning a docs-as-code workflow.

Summary of changes:

  • Reorganize the article so that it introduces the general workflow, then explains the Git concepts happening behind the scenes so that the abstraction of the editor isn't mysterious. This focuses on value for the user (what the web editor automates) and responding directly to common questions (when to use branches)
  • Then the article progresses through the editor flow
    • Creating a branch
    • Making changes
    • Creating PRs, reviewing, merging
    • Troubleshooting
  • Adds info on common tasks
    • How to create pages
    • Example of updating navigation

Closes https://linear.app/mintlify/issue/DOC-69/web-editor-docs


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

Copy link
Contributor

@baell baell left a comment

Choose a reason for hiding this comment

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

Left nits but good to go

@ethanpalm ethanpalm merged commit f0ad93a into main Jun 19, 2025
4 checks passed
@ethanpalm ethanpalm deleted the web-editor-guide branch June 19, 2025 00:31
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