-
Notifications
You must be signed in to change notification settings - Fork 181
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
Editor updates #797
Conversation
There was a problem hiding this 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
Thanks for taking a look!
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.
This should be covered in the permissions section updates since any OS contributors would be non-editors:
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? |
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
✅ Clarity and completeness
✅ User experience