Skip to content

Editor updates #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Editor updates #797

wants to merge 3 commits into from

Conversation

ethanpalm
Copy link
Contributor

Documentation changes

Based on customer confusion, this PR clarifies what an editor is and when the web editor will publish live updates.

Closes https://linear.app/mintlify/issue/DOC-39/clarify-web-editor-terminology


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
Collaborator

@Sahu97494 Sahu97494 left a comment

Choose a reason for hiding this comment

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

Can we clarify exactly what happens when an editor hits publish on the web editor as well - does it create a branch or does it push to the live site directly so our AI Assistant can index it as well?

Maybe also add a callout explaining the usecase for public repos/OS where this doesn't apply because they are using only the CLI workflow

@ethanpalm
Copy link
Contributor Author

Thanks for taking a look!

Can we clarify exactly what happens when an editor hits publish on the web editor as well - does it create a branch or does it push to the live site directly so our AI Assistant can index it as well?

I'll push a commit to clarify this. It depends on whether or not someone is on their main branch. If on main, the publish button will make changes live. If on a branch, it'll open a pull request to review and merge via GitHub.

Maybe also add a callout explaining the usecase for public repos/OS where this doesn't apply because they are using only the CLI workflow

This should be covered in the permissions section updates since any OS contributors would be non-editors:

Anyone can contribute to your documentation by working locally and pushing changes to your repository, but there are key differences in how changes get deployed:

 * **Editor changes**: When an editor publishes through the web editor or merges a pull request into your docs repository, changes deploy to your live site automatically.


 * **Non-editor changes**: When a non-editor merges a pull request into your repository, you must manually trigger a deployment from your dashboard for those changes to appear on your live site.

I didn't add this to the quickstart since it seems like a more advanced topic. Do you know if it's something that many people will want to know when going through the quickstart?

When you're ready to make your changes live, click the **Publish** button in the top-right corner of the web editor.

Your changes will be deployed to your production site immediately.
* **Main branch**: Updates your live site immediately.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would probably make a distinction from Main branch, i.e. Deploy branch or something along those lines, because for our case, you can configure your docs instance to not use the main branch of your repo as the branch we deploy from.

I.e. you could have a main branch and a docs branch and configure Mintlify to deploy from the docs branch.

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