From 6d712f99cda3a04d8c8095dce1658919671ff1a3 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 11:59:43 -0700 Subject: [PATCH 01/17] update quickstart web editor content --- editor.mdx | 2 +- quickstart.mdx | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/editor.mdx b/editor.mdx index 524a105ba..605dd0e81 100644 --- a/editor.mdx +++ b/editor.mdx @@ -20,7 +20,7 @@ icon: "mouse-pointer-2" The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser. -The web editor offers a **What-You-See-Is-What-You-Get (WYSIWYG)** experience while maintaining synchronization with your Git repository, which lets you see updates in real time and collaborate with your team on documentation changes. +The web editor offers a **what-you-see-is-what-you-get (WYSIWYG)** experience while maintaining synchronization with your Git repository, which lets you see updates in real time and collaborate with your team on documentation changes. ### Web editor vs. CLI diff --git a/quickstart.mdx b/quickstart.mdx index 3cd324529..3c4ff2bc5 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -158,7 +158,7 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf ### Access the Web Editor -1. Log in to your [Mintlify Dashboard](https://dashboard.mintlify.com). +1. Log in to your [dashboard](https://dashboard.mintlify.com). 2. Select **Editor** on the left sidebar. @@ -174,9 +174,9 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: -Find and click on `introduction.mdx` in the file explorer. +Find and select `introduction.mdx` in the file explorer. -Then, in the visual editor, update the title field to "Hello World". +Then, in the editor, update the title field to "Hello World". Editing in Web Editor @@ -192,10 +192,10 @@ Then, in the visual editor, update the title field to "Hello World". When you are satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. -Use branches to preview and review changes through pull requests before deploying to your live site. + Use branches to preview and review changes through pull requests before deploying to your live site. -For more details about using the web editor, including using branches and pull request to collaborate and preview changes, see our [Web Editor documentation](/editor). +For more details about using the web editor, including using branches and pull request to collaborate and preview changes, see our [web editor documentation](/editor). ## Adding a Custom Domain From c7135796772124259412396c8b8b20bb8e964829 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 12:06:30 -0700 Subject: [PATCH 02/17] update introduction --- editor.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/editor.mdx b/editor.mdx index 605dd0e81..5a3d9bcd9 100644 --- a/editor.mdx +++ b/editor.mdx @@ -7,13 +7,13 @@ icon: "mouse-pointer-2" Mintlify Web Editor interface in light mode Mintlify Web Editor interface in dark mode ## Introduction @@ -22,7 +22,7 @@ The web editor is a visual interface for creating, editing, and reviewing docume The web editor offers a **what-you-see-is-what-you-get (WYSIWYG)** experience while maintaining synchronization with your Git repository, which lets you see updates in real time and collaborate with your team on documentation changes. -### Web editor vs. CLI +### Choosing your tool The web editor lets you write and edit your documentation in your browser without requiring local development tools or using the command line. You should use the web editor if you want to maintain your documentation in one place with one tool. @@ -30,7 +30,7 @@ The CLI is a command line tool that allows you to create and manage your documen Both the web editor and CLI are fully integrated with your Git repository, so you can use them interchangeably and different members of your team can use either tool based on their preferences. -## Editor Modes +## Editor modes The web editor offers two modes to accommodate different editing preferences and needs. From 673f804056217def2cb537871379e3dc5d2b3b55 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 12:09:00 -0700 Subject: [PATCH 03/17] update Editor modes section --- editor.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/editor.mdx b/editor.mdx index 5a3d9bcd9..4b21c3c66 100644 --- a/editor.mdx +++ b/editor.mdx @@ -32,9 +32,9 @@ Both the web editor and CLI are fully integrated with your Git repository, so yo ## Editor modes -The web editor offers two modes to accommodate different editing preferences and needs. +The web editor has two modes to accommodate different editing preferences and needs. -You can switch between natural modes at any time using the toggle in the top right corner of the editor toolbar. +You can switch between modes at any time using the toggle in the top right corner of the editor toolbar. -### Visual Mode +### Visual mode Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time. @@ -86,9 +86,9 @@ You can add content blocks and other components to your documentation in visual /> -### Markdown Mode +### Markdown mode -Markdown mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you prefer to write in Markdown/MDX syntax. +Markdown mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you prefer to write in Markdown syntax. Date: Tue, 17 Jun 2025 12:09:52 -0700 Subject: [PATCH 04/17] move component menu to Making changes section --- editor.mdx | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/editor.mdx b/editor.mdx index 4b21c3c66..205b3c8ad 100644 --- a/editor.mdx +++ b/editor.mdx @@ -66,26 +66,6 @@ Visual mode provides a WYSIWYG experience where the changes that you make in the /> -#### Component Menu - -You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. - -1. Press the `/` key to open the component menu. -2. Select a component from the menu. - - - The unfurled component menu emphasized in the Mintlify web editor - The unfurled component menu emphasized in the Mintlify web editor - - ### Markdown mode Markdown mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you prefer to write in Markdown syntax. @@ -110,6 +90,26 @@ Markdown mode provides direct access to the underlying MDX code of your document 3. **Make changes**: Edit the content using visual or Markdown mode. Changes are automatically saved as drafts. 4. **Preview changes**: See how your changes will appear in visual mode. +#### Component Menu + +You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. + +1. Press the `/` key to open the component menu. +2. Select a component from the menu. + + + The unfurled component menu emphasized in the Mintlify web editor + The unfurled component menu emphasized in the Mintlify web editor + + ## Publishing The **Publish** button works differently depending on your branch: From 0cfe2e803e4c7177fe88887422b0f5ae7276aef6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:32:30 -0700 Subject: [PATCH 05/17] update page structure --- editor.mdx | 200 ++++++++++++++++++++++++++++------------------------- 1 file changed, 107 insertions(+), 93 deletions(-) diff --git a/editor.mdx b/editor.mdx index 205b3c8ad..e0b4d2beb 100644 --- a/editor.mdx +++ b/editor.mdx @@ -22,6 +22,8 @@ The web editor is a visual interface for creating, editing, and reviewing docume The web editor offers a **what-you-see-is-what-you-get (WYSIWYG)** experience while maintaining synchronization with your Git repository, which lets you see updates in real time and collaborate with your team on documentation changes. +An understanding of Git fundamentals is helpful to use the web editor effectively. + ### Choosing your tool The web editor lets you write and edit your documentation in your browser without requiring local development tools or using the command line. You should use the web editor if you want to maintain your documentation in one place with one tool. @@ -49,6 +51,15 @@ You can switch between modes at any time using the toggle in the top right corne /> + +Overview of the web editor flow: + +1. **Create a branch (optional)**: TODO: +1. **Find your file**: Use the sidebar file explorer to navigate through your documentation, or select Command + P (Ctrl + P on Windows) to search for files. +1. **Edit your content**: Make changes using either visual mode or Markdown mode. Your changes save automatically as you type. +1. **Preview your changes**: See how your changes will appear in visual mode. +1. **Publish your changes**: Select the **Publish** button to publish your changes to your live documentation site. + ### Visual mode Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time. @@ -83,62 +94,72 @@ Markdown mode provides direct access to the underlying MDX code of your document /> -## Making Changes +## Git fundamentals -1. **Browse files**: Use the sidebar file explorer to navigate through your documentation. -2. **Open a file**: Click on the file that you want to edit to open it in the editor. -3. **Make changes**: Edit the content using visual or Markdown mode. Changes are automatically saved as drafts. -4. **Preview changes**: See how your changes will appear in visual mode. +### Branches -#### Component Menu +Branches allow you to safely work on changes without affecting your live documentation. When your changes are ready, you can merge them into your deployment branch with a pull request. -You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. + + Use branches for significant updates, new sections, or when multiple team members are working on different parts of the documentation simultaneously. + -1. Press the `/` key to open the component menu. -2. Select a component from the menu. - - The unfurled component menu emphasized in the Mintlify web editor - The unfurled component menu emphasized in the Mintlify web editor - +## Git Synchronization -## Publishing +The web editor integrates with your Git repository, ensuring that all changes are properly versioned and tracked. -The **Publish** button works differently depending on your branch: +### How Git Sync Works -* **Deployment branch**: Updates your live site immediately. This is usually the `main` branch. -* **Other branches**: Creates a pull request for review. +* **Authentication**: The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab). - - The publish button emphasized in the Mintlify web editor - The publish button emphasized in the Mintlify web editor - +* **Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's deployment branch. -## Branches +* **Change tracking**: As you make edits, the web editor tracks changes and can commit them to your repository. -Branches allow you to safely work on changes without affecting your live documentation. When your changes are ready, you can merge them into your deployment branch with a pull request. +* **Branching**: You can make changes directly to your deployment branch or to a separate branch, depending on your workflow preferences. - - Use branches for significant updates, new sections, or when multiple team members are working on different parts of the documentation simultaneously. - +* **Pull requests**: For collaborative workflows, you can create pull requests from the web editor. + +### Git Terminology + +Understanding the following terms can help you work more effectively with the web editor and the Git workflow. + + + + + +A repository (or repo) is where your documentation files are stored, along with their revision history. The web editor connects to your Git repository to fetch and store documentation content. + + + + + +A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the web editor, you're creating a commit in your Git repository. + + + + + +A branch is a parallel version of your documentation that allows you to work on changes without affecting the live version. The web editor allows you to create and switch between branches. + + + + + +A pull request (or PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated. + + + + + +A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. + + + + -### Creating a Branch +## Creating a Branch 1. Select the branch name in the editor toolbar (usually `main` by default). 2. Select **New Branch**. @@ -150,13 +171,39 @@ Branches allow you to safely work on changes without affecting your live documen 1. Select the current branch name in the editor toolbar. 2. Select the branch that you want to switch to from the dropdown menu. +## Making changes + ### Saving Changes on a Branch To save your changes on a branch, select the **Save Changes** button in the top-right corner of the editor. When you are working on a branch, your changes are not automatically saved. -## Pull Requests +### Finding and creating files + +### Editing content + +#### Component Menu + +You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. + +1. Press the `/` key to open the component menu. +2. Select a component from the menu. + + + The unfurled component menu emphasized in the Mintlify web editor + The unfurled component menu emphasized in the Mintlify web editor + + +## Pull Requests and reviewing changes Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation. @@ -188,59 +235,26 @@ After you create a pull request, you can see a preview deployment of the changes After a reviewer approves a pull request, you can merge it to deploy the changes to your live documentation site. -## Git Synchronization - -The web editor integrates with your Git repository, ensuring that all changes are properly versioned and tracked. - -### How Git Sync Works - -* **Authentication**: The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab). - -* **Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's deployment branch. - -* **Change tracking**: As you make edits, the web editor tracks changes and can commit them to your repository. - -* **Branching**: You can make changes directly to your deployment branch or to a separate branch, depending on your workflow preferences. - -* **Pull requests**: For collaborative workflows, you can create pull requests from the web editor. -## Git Terminology +## Publishing changes -Understanding the following terms can help you work more effectively with the web editor and the Git workflow. - - - - - -A repository (or repo) is where your documentation files are stored, along with their revision history. The web editor connects to your Git repository to fetch and store documentation content. - - - - - -A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the web editor, you're creating a commit in your Git repository. - - - - - -A branch is a parallel version of your documentation that allows you to work on changes without affecting the live version. The web editor allows you to create and switch between branches. - - - - - -A pull request (or PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated. - - - - - -A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. +The **Publish** button works differently depending on your branch: - +* **Deployment branch**: Updates your live site immediately. This is usually the `main` branch. +* **Other branches**: Creates a pull request for review. - + + The publish button emphasized in the Mintlify web editor + The publish button emphasized in the Mintlify web editor + ## Troubleshooting From 108e768ef3b81f488b017a2b6ba43d2e252937ac Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:52:33 -0700 Subject: [PATCH 06/17] remove info about CLI --- editor.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/editor.mdx b/editor.mdx index e0b4d2beb..45d8f9fb2 100644 --- a/editor.mdx +++ b/editor.mdx @@ -24,13 +24,9 @@ The web editor offers a **what-you-see-is-what-you-get (WYSIWYG)** experience wh An understanding of Git fundamentals is helpful to use the web editor effectively. -### Choosing your tool - The web editor lets you write and edit your documentation in your browser without requiring local development tools or using the command line. You should use the web editor if you want to maintain your documentation in one place with one tool. -The CLI is a command line tool that allows you to create and manage your documentation locally using the IDE of your choice. You should use the CLI if you want to integrate documentation into your existing development workflow. - -Both the web editor and CLI are fully integrated with your Git repository, so you can use them interchangeably and different members of your team can use either tool based on their preferences. +The web editor is fully integrated with your Git repository, so different members of your team can collaborate on documentation changes. ## Editor modes From b2f71ecdbc790338c2db39fdebeb649ff1643be7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 14:21:03 -0700 Subject: [PATCH 07/17] update introduction --- editor.mdx | 52 ++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 16 deletions(-) diff --git a/editor.mdx b/editor.mdx index 45d8f9fb2..bb0ef25ce 100644 --- a/editor.mdx +++ b/editor.mdx @@ -20,13 +20,34 @@ icon: "mouse-pointer-2" The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser. -The web editor offers a **what-you-see-is-what-you-get (WYSIWYG)** experience while maintaining synchronization with your Git repository, which lets you see updates in real time and collaborate with your team on documentation changes. - -An understanding of Git fundamentals is helpful to use the web editor effectively. - -The web editor lets you write and edit your documentation in your browser without requiring local development tools or using the command line. You should use the web editor if you want to maintain your documentation in one place with one tool. - -The web editor is fully integrated with your Git repository, so different members of your team can collaborate on documentation changes. +- **Visual editing**: Make changes to your documentation using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published. +- **Git synchronization**: All changes automatically sync with your Git repository to maintain version control. +- **Real-time collaboration**: Multiple team members can work on documentation simultaneously, with changes visible to everyone. +- **No setup required**: Start writing immediately from your dashboard. + +This guide covers everything you need to know to use the web editor effectively, including Git fundamentals. + +### Web editor flow + +Here is how you'll typically work in the web editor: + + + + Create a branch or make changes directly to your deployment branch. + + + Navigate to an existing file or create a new one. + + + Make changes in the web editor using either visual mode or Markdown mode. Your changes save automatically as you type. + + + See how your changes will appear in visual mode. + + + If you're working on your deployment branch, publish your changes directly from the web editor. On other branches, publish your changes through a pull request. + + ## Editor modes @@ -47,15 +68,6 @@ You can switch between modes at any time using the toggle in the top right corne /> - -Overview of the web editor flow: - -1. **Create a branch (optional)**: TODO: -1. **Find your file**: Use the sidebar file explorer to navigate through your documentation, or select Command + P (Ctrl + P on Windows) to search for files. -1. **Edit your content**: Make changes using either visual mode or Markdown mode. Your changes save automatically as you type. -1. **Preview your changes**: See how your changes will appear in visual mode. -1. **Publish your changes**: Select the **Publish** button to publish your changes to your live documentation site. - ### Visual mode Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time. @@ -177,8 +189,12 @@ When you are working on a branch, your changes are not automatically saved. ### Finding and creating files +Use the sidebar file explorer to navigate through your documentation, or select Command + P (Ctrl + P on Windows) to search for files. + ### Editing content +Make changes using either visual mode or Markdown mode. Your changes save automatically as you type. + #### Component Menu You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. @@ -203,6 +219,8 @@ You can add content blocks and other components to your documentation in visual Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation. +See how your changes will appear in visual mode. + ### Creating a Pull Request on a Branch 1. Make your changes on a branch. @@ -234,6 +252,8 @@ After a reviewer approves a pull request, you can merge it to deploy the changes ## Publishing changes +Select the **Publish** button to publish your changes to your live documentation site. + The **Publish** button works differently depending on your branch: * **Deployment branch**: Updates your live site immediately. This is usually the `main` branch. From 0c4626c70df2adb90a0cefc166f6aa49e752c38a Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 14:31:35 -0700 Subject: [PATCH 08/17] update editor modes --- editor.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editor.mdx b/editor.mdx index bb0ef25ce..eaf1edc27 100644 --- a/editor.mdx +++ b/editor.mdx @@ -87,7 +87,7 @@ Visual mode provides a WYSIWYG experience where the changes that you make in the ### Markdown mode -Markdown mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you prefer to write in Markdown syntax. +Markdown mode provides direct access to the underlying `MDX` code of your documentation. `MDX` combines Markdown syntax with React components, giving you full control over your content structure. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax. Date: Tue, 17 Jun 2025 15:18:31 -0700 Subject: [PATCH 09/17] update git fundamentals --- editor.mdx | 78 +++++++++++++++++++----------------------------------- 1 file changed, 27 insertions(+), 51 deletions(-) diff --git a/editor.mdx b/editor.mdx index eaf1edc27..027228ec4 100644 --- a/editor.mdx +++ b/editor.mdx @@ -25,8 +25,6 @@ The web editor is a visual interface for creating, editing, and reviewing docume - **Real-time collaboration**: Multiple team members can work on documentation simultaneously, with changes visible to everyone. - **No setup required**: Start writing immediately from your dashboard. -This guide covers everything you need to know to use the web editor effectively, including Git fundamentals. - ### Web editor flow Here is how you'll typically work in the web editor: @@ -104,68 +102,46 @@ Markdown mode provides direct access to the underlying `MDX` code of your docume ## Git fundamentals -### Branches - -Branches allow you to safely work on changes without affecting your live documentation. When your changes are ready, you can merge them into your deployment branch with a pull request. - - - Use branches for significant updates, new sections, or when multiple team members are working on different parts of the documentation simultaneously. - - - -## Git Synchronization - -The web editor integrates with your Git repository, ensuring that all changes are properly versioned and tracked. - -### How Git Sync Works - -* **Authentication**: The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab). - -* **Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's deployment branch. - -* **Change tracking**: As you make edits, the web editor tracks changes and can commit them to your repository. - -* **Branching**: You can make changes directly to your deployment branch or to a separate branch, depending on your workflow preferences. - -* **Pull requests**: For collaborative workflows, you can create pull requests from the web editor. - -### Git Terminology - -Understanding the following terms can help you work more effectively with the web editor and the Git workflow. +The web editor performs Git operations behind the scenes. Understanding these concepts will help you work more effectively with the web editor. + + Your documentation's source where all files and their history are stored. The web editor connects to your repository to access and modify content. + - - -A repository (or repo) is where your documentation files are stored, along with their revision history. The web editor connects to your Git repository to fetch and store documentation content. - - - - - -A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the web editor, you're creating a commit in your Git repository. - - + + A saved snapshot of your changes at a specific point in time. + - + + A separate workspace for making changes without affecting your live documentation. Think of it as a safe sandbox for experiments and larger updates. + -A branch is a parallel version of your documentation that allows you to work on changes without affecting the live version. The web editor allows you to create and switch between branches. + + A way to propose merging your branch changes into your live documentation. Allows for review and discussion before changes go live. + + + A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. + - +### What the web editor does for you -A pull request (or PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated. +The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab) and handles Git automatically. When you: - +- **Open a file**: Fetches the latest version from your repository. +- **Make changes in a file**: Tracks your changes as a draft that can become a Git commit. +- **Save changes**: Creates a commit with your changes. +- **Create a branch**: Creates a new branch in your repository. +- **Publish on your deployment branch**: Creates a commit and pushes directly to your deployment branch. +- **Publish on other branches**: Creates a commit and opens a pull request. - +### When to use branches -A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. +Branches let you work on changes without affecting the content on your live site. When your changes are ready, you can merge them into your deployment branch with a pull request. - - - +**Best practice: Always work from branches.** This ensures your live documentation stays stable and enables proper review workflows. ## Creating a Branch From e020ee4fe3c314978f1a4fb9a2d4b06cc6cb081d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 15:49:39 -0700 Subject: [PATCH 10/17] add info on deployment branches --- editor.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/editor.mdx b/editor.mdx index 027228ec4..9d8915585 100644 --- a/editor.mdx +++ b/editor.mdx @@ -117,7 +117,11 @@ The web editor performs Git operations behind the scenes. Understanding these co A separate workspace for making changes without affecting your live documentation. Think of it as a safe sandbox for experiments and larger updates. - + + The main branch that contains your live documentation content. Changes to this branch are automatically published to your documentation site. Often called `main`. + + + A way to propose merging your branch changes into your live documentation. Allows for review and discussion before changes go live. From be73baf1687f88dfd6c01ae84aa9414ee822b80d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 17 Jun 2025 16:03:16 -0700 Subject: [PATCH 11/17] update branch procedures --- editor.mdx | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/editor.mdx b/editor.mdx index 9d8915585..015388171 100644 --- a/editor.mdx +++ b/editor.mdx @@ -147,17 +147,25 @@ Branches let you work on changes without affecting the content on your live site **Best practice: Always work from branches.** This ensures your live documentation stays stable and enables proper review workflows. -## Creating a Branch +## Creating a branch 1. Select the branch name in the editor toolbar (usually `main` by default). 2. Select **New Branch**. -3. Enter a descriptive name for your branch. +3. Enter a descriptive name for your branch like `update-getting-started` or `fix-installation-steps`. 4. Select **Create Branch**. -### Switching Branches + + You may need to select your new branch from the dropdown menu if the editor does not automatically switch to it. + + +### Switching branches 1. Select the current branch name in the editor toolbar. -2. Select the branch that you want to switch to from the dropdown menu. +2. Select the branch you want to switch to from the dropdown menu. + + + Any unsaved changes will be lost when switching branches. Make sure to save or publish your work before switching. + ## Making changes From d6d677b58b6a59a4a235b7f0187ee4855b1193d6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 18 Jun 2025 13:30:08 -0700 Subject: [PATCH 12/17] update making changes section --- editor.mdx | 71 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 55 insertions(+), 16 deletions(-) diff --git a/editor.mdx b/editor.mdx index 015388171..a14f40c90 100644 --- a/editor.mdx +++ b/editor.mdx @@ -37,7 +37,7 @@ Here is how you'll typically work in the web editor: Navigate to an existing file or create a new one. - Make changes in the web editor using either visual mode or Markdown mode. Your changes save automatically as you type. + Make changes in the web editor using either visual mode or Markdown mode. See how your changes will appear in visual mode. @@ -130,7 +130,7 @@ The web editor performs Git operations behind the scenes. Understanding these co -### What the web editor does for you +### What the web editor automates The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab) and handles Git automatically. When you: @@ -158,6 +158,10 @@ Branches let you work on changes without affecting the content on your live site You may need to select your new branch from the dropdown menu if the editor does not automatically switch to it. +### Saving changes on a branch + +To save your changes on a branch, select the **Save Changes** button in the top-right corner of the editor. + ### Switching branches 1. Select the current branch name in the editor toolbar. @@ -169,26 +173,17 @@ Branches let you work on changes without affecting the content on your live site ## Making changes -### Saving Changes on a Branch - -To save your changes on a branch, select the **Save Changes** button in the top-right corner of the editor. - -When you are working on a branch, your changes are not automatically saved. +Edit existing content, create new pages, and organize your site structure in the web editor. -### Finding and creating files +### Navigating files -Use the sidebar file explorer to navigate through your documentation, or select Command + P (Ctrl + P on Windows) to search for files. +Use the sidebar file explorer to browse your documentation, or select Command + P (Ctrl + P on Windows) to search for files. ### Editing content -Make changes using either visual mode or Markdown mode. Your changes save automatically as you type. +Make changes to your pages using visual mode or Markdown mode. -#### Component Menu - -You can add content blocks and other components to your documentation in visual mode using the dropdown component menu. - -1. Press the `/` key to open the component menu. -2. Select a component from the menu. +In visual mode, select / to open the dropdown component menu. Add content blocks, callouts, code blocks and other components to customize your documentation. +### Creating new pages + +1. Select the **Create a new file** icon in the file explorer. +TODO: image +1. Enter a filename. +1. Select Enter to create the file. + +Your new page will open in the editor, ready for content to be added. + +### Updating navigation + +Add, remove, and reorder pages in your navigation by editing your `docs.json` file: + +1. Navigate to your `docs.json` in the file explorer. +1. Update the `navigation` property to get the navigation structure that you want. See [Navigation](/navigation) for more information. + +This example shows how to add a Themes page to the Profile group. + +```json title="Adding a Themes page" highlight="18" +{ + "navigation": { + "groups": [ + { + "group": "Getting started", + "pages": [ + "index", + "quickstart", + "installation" + ] + }, + { + "group": "Profile", + "pages": [ + "settings", + "account-types", + "dashboard", + "themes" + ] + } + ] + } +} +``` + ## Pull Requests and reviewing changes Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation. From 7f888ea27aa15e809c9ccde40960794f6ae2b89c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 18 Jun 2025 13:44:09 -0700 Subject: [PATCH 13/17] add file menu images --- editor.mdx | 17 ++++++++++++++++- images/editor/files-menu-dark.png | Bin 0 -> 12280 bytes images/editor/files-menu-light.png | Bin 0 -> 12197 bytes 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 images/editor/files-menu-dark.png create mode 100644 images/editor/files-menu-light.png diff --git a/editor.mdx b/editor.mdx index a14f40c90..e4507ac62 100644 --- a/editor.mdx +++ b/editor.mdx @@ -201,7 +201,22 @@ In visual mode, select / to open the dropdown component menu. Add con ### Creating new pages 1. Select the **Create a new file** icon in the file explorer. -TODO: image + Files menu in the web editor. + Files menu in the web editor in dark mode. 1. Enter a filename. 1. Select Enter to create the file. diff --git a/images/editor/files-menu-dark.png b/images/editor/files-menu-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..51f4267a4645980e318d63856dd256c11bf259b6 GIT binary patch literal 12280 zcmeHt^;cZo(k3(wG!USX;7*`}TY%8GTY%v17Nj9S<8BEMBtWpBNpN>}f?IG4?oM!L zI`6&fyWg6%X8wSg@0VWZoT~loeX7o`da8DZzg3pS#w5c;LPElpmy=RMLIPAGu0ud* zh+q5eK2pR3CL0YMxQ@~rsJSDI-PFR-%#z&$_8uWeLJ|`7cyDTMX9=edX<{rU()aQu~UaItf8{C9Or51apk`d`U^ z)c+2K>Zn<|INH1ZonDxZ>(wg`u79BZk?H;+IU#n>q^rkFUz2nE+vW)8ar~F} z5I6tje@h31)149CJ+V@dL_&I|Xd@~4R$fw)=B=}%m5se65|Uhaf;PI2dOuNyz8WnM zBqgS>qXdq{7gGSS1)S4`DaZjr@XaOOR{Z#cS!yU%{=JAMf)ZR|s!h~=q(_9s%(8FR zQQC}w44>0(ANSRrA1&^Wy@C9K5=*Xf`hSV#B^Jvt|hfio+D`YAeJR@F%Abp;?@zF&?B3t}yy@|!0 zg+nQWmG(lS0%#^0=IiVN!J^H;s=%%ebQw>$J*cLJb3f*$@a6Y!TR$_?Wc3ZDph;A8 zxt@3$h2I~?rT!pE?jqB=c%v&9$!(Qf2bqiS`l3U*h8tHMCKpzNEap^EK57)6k`nRR zBSF}f{*J+xLktj9&26~9NJ;bo^^Rv;LN)hTWx66cce<%_}a?_dCF80l%QB$14!RoX)eZ&wc zv0`MW5FtUn;$_Ahns{<96MFTZFU>0gbQt4+cSYwF<8a-#Z`vM43~s~@X2aibaeSvX z9v+OuQr*P#rdzqX!8Pw_l*U)S4~Ui%VfUdS`u39M?Q=n8BKb9QO`%fA@L7y%RQF-F zfa=3#ecMZjPJgO61!Odak|Z?~oj6Z{nj>yYy1U^1=U~7;x;7^FWgrc-y;eYbwwpiN=)SSNL!gU@Rat+6;!nG zGdOK;4{7}F?hEtW3e(R9nr9pB-qM+I7QcdlCqV8se~+IZHIdBw0yXEJj&G1J1-k;@ zc!(n05-Uwz{sIjjC5-kb&3873fV&kVkJrt&9ea^gPBDS6TNem2@aI7>Ab!wch+zEB z&`MgPXw<{EqWPktHlkbTbwOWC>qU>Sr@nEI{KO7GIRb32uC%_l((ZGK;vh4pCEXzqfG<^1)2a^_mBBTj*j2&T3J9f%9-b>`c4zjm6e1RodmdPnaUt1sq+vi+8lKo2IgCnt zCfQn=sXmbnPG|gvfNEOz&mZL=r(`!FX8F*NW~i+XMGnja8lB3BOa!1oAo3VGJ4 zA%XYpOL_YHu=i+3IXInybg_Le^avJLjo#2%;aP)|!2IAVunKq~EGAs|1-^Wyg~}s{u8;Pb#@89rLU_~5>N3yg-(1`12^A~LNCelm}5##wo z6JXn+vHV~86ZM6E;*`JXj|-fKp98#@9*`cmTNLBJ+vN05ZP<-W7yl9}_EfBr{q&7j zfkll)+b(=sxdcmZv_^hjYd&yZ;t+LSzedGI)XLH*b- zGC-SL^;{cWYg`TC1n|6FtsSZ_+kIq6&X8;k&w^R z$?`K*Nx?3XF47PB*!s`BBO{}NqOxW7Bb7;ANqM3kBC8^`$*FmcUYRCeCxGptfNs8qxiktYcx&wBcdADHFcMr4z)E9DD~rjE!XXp3hIj2~ zvtP2)B}K8<8IqQo8xlA2HTk)^xW_k4HM%zH*XK2sxwmyso61%sm5+LZh3(C4wb=*(bEV$l;4#ezOjufAwu_>Eu4_ZKj zAbBa@7hxOHr4h~4mXy2Crh$thghW~3GIX6`+$pUz_RiQM^@7>)3j z)5KKds(PtAkuc;!?C(`N&4tDX0z%V@wm| zD%Eq2nV60I{1Lwse;tpLjju+a?w;$nDtpRuBW%-LePOc*C^acr3H_x~uQ$tdN>oB9 ztazntobo8tC1|cGW1Wj2Lsm)2EbPQ>1DO5uUoJ!hxxHoG9F@&RG7Ov@Y>!OCYhUO) zdsY6~u!&#Dz8t5sxg#89vde`Jc3LcKhWP|F)2g69?$o`sClqC(+Pd4&-tbTU%6ZZL zs>CMFhHc_7mm}k`m?nQEiS+teN90yYF3^?Hu&AC0@70xJWnznWrX|WkQ;AkT{rsdy9Anh%@Tbnq z^iMZ_Ufg&bhayms{ZVLdyE4-|DVGCgxK(Sv?!4yQf11kTqpeXgsi#|h`lqm>Xiuw3 zi@40M$!h#7Rt|ek>a^Mn^K@-eXcBL6l}??{V$$i*Df#oq=ibxgrN+&V4`{0&ipU@M zrX9HFH7a)}tp02*=m*tJYU*hwIxsj4FWxCMD6|0kS_!0gA>tb zsLd#tOC|SmXIy8jr|bA%@K#ge2><@QGv%=pwjN8Vl&kby)-{G*P)4|RMd$cW(7G@r z8`7w3mFDwXsNm+Pz$vdZGg@TPi}7ISrb^seC4D_j&~NF^X99H;>mx@c$F#9?lg7;2 zyz`Fsj4^IaW6iXoTifsV-RlbG3(2+S+P-BO%|!1H4_ucn6#3~Ksuv^MJnysyN-h^V z7eLO9jX+h!V%EUqC2l)01!eR^5MDlR2W zh)Q4#bTJBv?+cdVRQ(aOy-|>l7p2NY*PI^~w<58Yui^yO03(ND2nB}G4B!BQUaohZ z?(J8U@9yd~HWfA%-nx$#Oia1f9X}qWFFZB4CIxkNew9TQo|Gxi6#03E9k^vCXe=CZ;#GtW|)P<2?|7T>t=N#<+LO}+F#34!WeVO_&_Al6f z^gz1vf2a5#kpFjWqAB**y);8WGCq3>o;K4ineSJ(yGh=Xt!zyj3w1x=rSKv-r zbJ@&4Utfz#A|Wke(6yqNKX^nSuc@qasuajVwX2duaWzjCtJH%ar zC`SCX-aUO5pw|B>P_0M{_QdTZH%Fm6R|_kWlxwC%3iM$V^WStl;fqeU#vDT=<d>fK+H$FVH@$H*Lwu+;!@ubnlB-8R2X@MIhF{$ogR^`Qe4X9e!pAb(x#yM)n$* zv*6c&ua2mcy-xv2dQ@I4^;N;Swt`e%j>qO{MccrDNM)6kFxz6I>seujn)3Fseu{O&Ezh zFd)7Tw&h}wuA|Z=dyP^mUxPAhLU}0x0}YU7B_g09PDt0}IY=BHHb*l(fXkNy9evqg?(ue0I0N`0OUG-MD3{mOaakxqNSB8?S_ z7VUDXIpozETQqURpHYHi-WG#u)!~UD?a;~yT_DWt(Bi2{7cw_0P(?9y#Hsvgz>c=b zZiZdA5gradUh1m7BxcilY3z5C10xaoyGLHogQuxKT3Ch;@IbzO1Mt<%v?-dqm_CrW zDup(rh??;|w+)GcfO{Sb)qIdo|M*Sj8xNEk3bK7_g)Q*iOqI##->xGggElyjpFd;v zN=v(0Um?VKG6Bme{Y+dahJCB|P#(d`GSiZsdJmR+0iJqfJ`T0l)lE4+@GKR2yk4(# z*~YoqN_8}wxjbC3yglC?&r?~Rz50pP;r=&+D2Pepn(-OHIvi}p8GocSBC*6@8>vqE zrwxtimW{tie+LdT^G_g_(27ZOb&h9TWN7iaNOU`#?=4+wx$6_Yx*uaAd;Gh*!Bw<& zD9Y+s+)U96s%39Z-xFwuvYJg}7u;hJ@N$vo3snA)eM;hBE3B@bOoGc3B63xLyqG`5 zc|vKt9Cse+I}d|b81EL*#N`rWgwS2IW8O{scqly2d1U64&{7#?W@5rnVQE)GM51Gi z{I{>S)2KOjiYy_tMc?qML^(h0rAH6#S@K8G##h>rJCiw0aefu`9uLY;oh8>7nf z$>bHh#Yc=*0Ky-O5?-?rV@8cLmoiBOaprNC0Komvk=vxQ1*rK!^lhbL;Fl~w#72?m zv&yl#Ns?DpU7t-`;)CfaPUI?WG#%sg_e7CzcHz$S&)3*l_C`}aS~|p@GUcVw9WKQD@psTK)hH4$cd z5e|$%deF3*iY0C$nx);FuPK@=(q6uVLj3U449!GtYhVjnRwF(N=e=$leX;D)#bg>Z zuKUvo%MVBHAKu-!gR9gxBY7f(s;aF=Gb%0m%~E*n5}#2C&DMlzq7-VCFe0Kz;(|ky zl2$2e0=Z+eIJ4%!9pkR<;)b2X{0FpW^_&cNMa59J1N-L1YgJVHEtcPyR6=2_$VFqr zoJ6k`EHUW)A*s7%X&`~SA7p8yn?gTlE6g_%w2k;`(f1ipQFpaU)Hrgx#A`P*(FM8` zDsVBWZWucJ;&a3tlX`BSuC*(kp=NY&fIh(c>WFL0pp0{g1nxw>sZ;O&VAoyYT|}PF zqu)9ha2K`ZiX3b7`frr_1LWQ>OYDUtoQqK3vdCD(Yxz1*8^OmyD{ji?D$VY%ol1!U zcE49(vCF|iuJ_9ZBTH&UVyB9|{eyoXjAX)P zsoC>1b=d&2?5D3<|F}l{#I)XH2&u8lv_Px7r{J~y^4q`7n<^1wHP#)dRl>~ccC+HK z*IeWggK4i!J%(3819kbtDRUdFBUrE?<(~lM;X$LXWDF1RQT9FOaPCBO1M1g@)1a<} z@SR`sN3C~M=5{4D&etcavo#Kj(1zpIyBwEo_6ljkKTgF*ib_zj;%JhY(qcXA#&5keIPLjBvzB6LMc+{-LI^lvOWk3NV9^4Z1^(| zz{Of>@LmuXGbBf7HpLs@hNXLW?`-L5l1sF+e~3*ka{8sKsI1kB)#5fP&*nB|_GDGN zVIFeXu${rbb=I;o|0T)TuX|S1Er4s$Bn+08tCTt*4@rMETTty=Nj8i z6>6^PR-!L9xhI8U5i^`A+#VoI;3V{Th1j3+>!)CV8&I#tmR{-Wt9UYA+j&%%!@RSW znKEN*1M0?TNimQ`a6kkW&U7D|&C@AJ&EHa4U!Ly?8s^9XV6=F!dm*l(yB$<(Gci9l zWSxY@&U?lxW%jM~QTa^DY*H^~vpnQ3Ggf)L;f3eOn z^Cm$BWhAJy?#;Yx^FcjjkVUyJ<~$~27phZ#K3nfRppyzeAj2)x(AliI?X4Ev}9hqgRUoUlJ3c?4{$LaO?RtW6-BZu2-YfNHRK_2dv)xXlABN> z^iix4NcQTr@M3=H`t#@MtI%R~F{x4l+Iw2CA;5IMEJ%kSvJWj=3sL^;ybI6BuQBVs zi(WkdypGDZHK?&1Ok{f=mm>1uA6e3RRC@AzFYu`ISCf0@Y)%s+BDq5t9hSZJVPl~l z4tdl%IioHJ#`pfZ{0Y*r`z2W;ZA3u5)ig@{AcY@zdDebi?d0xp4So|}%DaW#%m z&mFr)TFL0;Z<3iQE@Q(O zC|1V5l*~fyOE?r-+P_Ro%_33j2rpAVX7_zgO_cYeMBHikE3cyMKrFqi#q|l^_m5N_ ztMEYm?Gfw#5DbFI*sV=9HSU>N#seXaIL0VMN!L5xdNJ*@4EmDTN=fKL#OAu2(kE+rd8A>p1D78Ns5V;6H>7TAc3 zNWKw264}zV578qsKK4wO8ZLBAaw`rfYwTl~t@j!`9@xKc(&$&1z$c;qcJw~!N_a}$&ADWd07utUau`mzZm7PyxR9I54Ky&uvwf*}m9l>f7Sp?+^SZdw&YZ4q=y=W~m zU8b2w+&>^3em9#*T)}wdtNHxJ=g~+K(}IblIo0mR+odx6+GR%Rsv=WGnKX#d!B;Ao zxZ8X-Vy4(8g)7XgUFLQ;@&%7x20=9+BEwggVE*vC!zVVyBz7KUb-m1F-ep=a2ml4- z(($S0LrL?TCb?9m!wDa?fL<4S^pt`b&(9t&7aSvNt66J1e=`e>(t@P{pt*p_y`xbP z9_340bGzX}O%}_YUo7@r8w2XwBg)B~T!}3XO*!7Z8SX~@0(S>hIZo>`(dbM%3x?nY zCew{R)oJmQK(T00ewfnlaGK}pL#hUbNIi0T%p0JEwkNT5{`DbqnnF!MagEtR{hGq_ zSr-QyujT6ggTn&~T|(OZ4mFf&f?K zR_8~)4hLeWi@b<9MuXQU^|L2Qa$?Nz*?aJNNwGS~2;z!AP9q{sH!)QmTnk$m$jkI2yRI}f@dL|QD;E=_oT8dWrI@V%G5rx`6B}SlBe$B4JeIw2 z2Y)c%t9@*(+i~zCb!pAB^(1uqO21eoF2i*5+iv1JN^?V(Vcuv{HSDY+qhXe*`jn96 z8oMOKF?r$PWugZ6Z<23!;0nUkTPS0FOykV7?m0)l6mx6=NgMZGFga5 zjk)M_N>6%C*i`l9(P9yGuRuCx))Q>k0q8bUQn%z|AjEIn=zhG#n9QnwnNjo}7!pH{2(L@EwY5ZkU zBf?h(z2#(L-D{npjtzQ9C)=W;$*+|7&(vL!JI{BIe%4$4EjSx)ww58o9FO0qjMLtj z^nP5W0*KRQnN5ud+}z#Vj*gW2oKDzKYmE$tHE9}TNYaD>hq}0f-lY=ran-bAMNs8B zbz$@O5vT~QCYvQNYesde@kGM3v<6zPmLLcUdF13&s8L{cusSc@6HU3Vcd|!1;8icq zUH5*K&SvbpC3o3+M!NeFlILy?vE}{szI13q0=b}DWJNu!xd>J-auXtLq($MG;R|q+ zn2^u@I$ikLnQV@?>omm>AYPD!hD|om4}mPFi`6Yxy0Gcj5((4Lj_neC5OlLodbqn{ z@cJXX225o0)^2p&C+%0Gvp~@*acpaOYvg;ON&4#DXO=-k#rHx*R9GFc)`eNTP-c@0 zX4c|WWcc8YN7j;`8NdR^OyZ43U5_5__guYid1kmK@hF=tSqb=K#6N7ZvXz0OB|fk`!_ znBW`5bqqPb(K$E(LHU|ST5P9md;E{{>Txnj-VY`Yb9RwCjaXELw=e8!eqkc$b20<+gSFZD z&b|+^cmL1qh_^*uIIP&pW0K3vF9rp>EkIP<00hBFtg(Ai8MvY?tvAZe&zBGFUiu^L zvmVuOdNE_%D;lx55B-WrT_oOJ)P*ZaQRs+V^j4V*7e@F)=0VMB^f9$a``8t0imce;c1E*Ci9hoW0tMQe!uiT;caZ=_@V$N~p&(wb(-$LxIBSr>|-~Zm@ys zb_cR>QpR`{^|xQYS7v32L0$La53~jz%Q}l6sg^uGxi-PtH-jckBs3j~mO#ta--m9U(7H3;*$R)Hxn3%}V zL*3}pj23JnqAhj{*_79;PgVxwq&IaFF=nUC`IN>k&1#nseA|l0?sNb-(EdtW;HBAg zl~kVZfZV^V27snTqrC=)e!jQ_@y`4e5gJ zB;+i(VE*3ATT7H(v`+!?JMZyh=2)ZV%`9UgbbNiSx6=k}iHSw8fN%}Im&L=E-+vg+ z_pWs+wHFwsTu>gVq4j#@5&`qri_y9V2vWdf~S8>^i_9FYLH-omQWe^SvpEPF8u3I>7Hr+aZc~p>5$r96RYbt-h9) zlkqbl$EcbY%j~HSC;BH9@tb6F;VfnaU-syf~`ic&f(BPE$B(r zT%n!O^Lq8;Cc;S8LB?LjiV6x+Wtk5Lq6nh6I^O8Y(mT-)3+@V8jz=~+C z5ie4qp$AF<9JXKW;f7ELsfI>JsJSpSJtEcPi5ARPdS6+~h^o;v0!Wf50b4N*ski5Y z->?0n5e0LUrOV~qq8a*_NBTB`OSF1+dNIycGX|af! z!#ysV)ac?`N9d~;xS7biHO9;_sTaR9X@1-5=|R-4+>d-ll0%Jwo2DcWs-p?X2sZpJ zo1s9L=Y}s7(XQjmP1kj-xah>Hl3s3RfKtAE&%+r{5_4QY0Fvg-!j2ceq z(|9_7Coj2w4})oo!*x^iz(0e`2@pp!B7m)T?@DDx@WXfQ1Vm-R^{d}KAB>2dlUjT9 z=kRB1-n@%Uy8>P=(>a4!0<$i(l_?Nq96f?P%Qd3@_C7|va{N|V5&KA;hWSzSZ=som zAO~-E-|5yaA~;4=)WFx9y-U}vn1q?jot-c$=hHvE`@;vg)eQ{T>DEPg z!fVbdG)WH$3*$vmx#{|~_T16@kJCCo4M%m()TWX#>-7^^bzjV1p-yqpkxzc@U`Moj z;sThcc*Xc+t=G?@_(yz>rimWLe%(YwkrQ`A)K`sUtrQiEN>0+y!2x0(pyY>Oy@T4A zKCRu!T93O|#t*W62JmDyLGFHZ+EfhTHAFfWpf_=Ay|sCKea)3OMp3|dR>fR?n`(-G z$VC0;rKpm^`u@J%V)_cAmg6R}PgJ2VS4i4MU|(Y-`v&_lUg9>qOuv-3RV+NKaxpDZ z&j9H{B(5cq0D%ybN4YSdIaLz5H~bS@I!X}^7x^_K(MuFu>e}VplRmsB_k0Y(&!0)x zbNxZOvCg)o4?TGTyir4cPa&jI1DLE_lK>RJ-}ti)E=`ti(cMN#PeuhF+k(u@OVW%4t literal 0 HcmV?d00001 diff --git a/images/editor/files-menu-light.png b/images/editor/files-menu-light.png new file mode 100644 index 0000000000000000000000000000000000000000..e3936f75421ddba0cf360dddad5e72519680f0de GIT binary patch literal 12197 zcmeHtWl)@36DCY1!QCMQOVA)8!QBb&gS!L|Ft`l?f_n%q!C`QB2o?zLF2UUf*B$P6 z_uj9zYWMe6?f#+WeY?+d&fDFml@KKbDGXFnR0ISBjE~adDhLRGa`^8r$S>f3TP<&S z;4c^~)ilAH@^ZW;_O>iWruN2WEN-@+;dBH9ej&HdMkdx~U`k^%3rjlz>Z7JMYD!B} z0csG3Je&MyF|$vW(jJaxsvZhzCLY!%Jf_q_f~fp%yl?9^Y~}{>;nD z>gwvs;`*M&-qC{f9S;u=D;qm2J3BL+gW1X54s7JcZ0AJt1o0mXaWf|qN6XJ(OM5%Y zCrl$_duOl!H8q@0`8PP&()?d^JEy-tA1(;iCkpF37B<%ZW;b)Q{NJ!YQT}CrTFk4d zV&-IT;FLem!xiI2|q9UU(230;8n78GqceWx3o30bNUbL zd$#|Ds`+13PHyghsp?KRu@V0=lfFn3&Q>F)>OdM|*Qi8#4q1>5zC3lBQ}OVY-eA6%bimSY}%u zI|f%+2ALUhMjb384G6$B5mlImz70@20|15y%qz%p*MNp^ zcmxEPh9sXJ^_Lcb!IdqWnG-h_kG{;>qA|J%2)NH3l9gC`1Ft9%+~R~8`=3GR1DmfW z_zQ8%zG_OnAP=aQ33;zp|1o4-?Mfy?UKgEcl@1|#^4d%51p?_}w8aJ*dnP8iBwFfg z(F&lkP_Vb76CD~=I$8xrwV%^i{LOwf1(^LIFNw3DZ_5JRSpBVc;7iKyvQAgykHg@* zqu7*e;>1o;jdM9I>2P-Q#5%g!xXy2yAlRU_PZAA?{aVE4nC(W#qE1$a%-#5 zOZy9b!1KLc&&C;S__|V%;@izK{_M%ic)`3hhSl>ulgQ^u4k6g8RG7U)bmGFrhz=NYCE*WxN+kk51;UT3ChGj9bc3)c<%sTs93JKSi~2Tt zI?cWmk(YGCQRKua8AwF=G8C+_n-blHcU}EeS3i^)eUDoxUw#%rFhqP_Y-z~e3s{{h zya7vF<4w!kb9`D3%M|S70TTe&q85 zC7}W#Axoi6q`EK3rS(FG7?VHPhq^Ez&kg}we^y#Qn}d2CZ|^nC13AQR?Q!mo18xrJ z74W~Yhp$RiknpN>Ds(z4NhIx2z_L#{Y}u9Cf6!2l2@j6;vu|C3Y+lhdyx6LtT^t%$%U0Nqcm&nUWxTn zBN$75!^mHvu}M3G&v5X%a4V!zaX44~fz*Gb(PIO0s7Zo>%9QV8uBA~baT%m)DJOdc z*V!C#8z9wGuF*l#bf=`(0mcQqMgF8eG`6L`ML3SIeZWkEm}jbv0KkZi_{?HVqk5mn zJ#bqBmW1a=i9TVyVB-i6NixPHCR;O((PaM~*;hWR`A#EL-MB`R#%pN0+@%=pHW<(0 z#ZU+N3M%H$H3vk&=NS>KKl@J@n=yqV3_2-R7q7Sg5r)#`bZ)qA0S*D^9crRDKfaZx zeGdNo;xHGpgO56<_q8_O;vaoEYI7V5>;!Bs>`QD#?D^oR5P{dYA2Uo9PiZA$uX6ZR za4g9!iFUYm7z_Q+{E8(xsrcgjd;3gL8lrV&mOctfw#xWOKFE#cXsYlt#Nbnz@tTpC zk>$oXCXI<)%S~o!tF{z6OuXIYw<4+e?(x+l>PAvteo$^uj9FX0m=jbYXInPsUK3if}i8qRs*92 zBL(C2MJKTeKXk@;&O*)r9t`&g_v|gQaaoqReUt0fLsP{g{Kf9FRZ?L;IAoYqm_XJc zQwk+$+QT&;=QQU0=0p#k&*{`CS_+vPqC34vpfVh=urWzB0&inG7dyN0YVp3|ZF1Ij zZgj43)&t{#^LI41UrpLt7|SuyMkRIX_ACrH_uYLM_(W`x_-SUb=MP?TdQ9G?D6`YW@)~EYKUj?xA0jvJmU@dp#a6qbrN? zbrN@yeAU6wLH7&~kN6UiBe@r@K;lgDKH@&SDjY;c@&53GQQ}o%u)IdfORj7G-2T;a zM@_Th@nSnwv2kqGz#YPIjqzdgDf1KaKy%N5!xYuQ+0C6z=wQlV6SLgg9_@kZf{Lrb zSmVChfoffA_o364_!{-BNl~Z=bZg3EihmEVN4n?9`GL$Jg@H4kbJ{kf)@I&j9-|ht zufzvxl50Y3>c1#xNokq!@%Nrb?m&*hiN%ShvEwP=`~32h-0I~kUUu?May0Tia)Zcf z;v{~@?p`OFHl7CF4Q^YfMm`x&we5lq<%n#3zIh(BRHoFjsJsYFQUMEa=QfDtf`vLE zf~8K6q|`)@sFAbD$Jxm>u3@s#xlyM+zp>1FnJ04lgKf*DW5A z{Q4f(J=^WRbF|J16Iy>v-|I{37Qlf#2O{AkRll%8>OuOBB#6w8_8YkfWf#*0BOS+! zIshA&u#$S6a5$K5MIF{CwkT#1n2xE66^6lt<%w@c#DZr3GAt5fzb*SpmlVO*}rQ>)V7mF8LM|T;H^|H;}ODfb_M)~(3$`oFnd_CK! zq47{xcHDN{RUBpxt_q&2Yo5;^sZ*wF0n6sd+{p_O*_qN9D=7 zW!!wu#Td2aE&ecrbso6C!*qTl*y~F(l_Ju^b{)M9z7WH!&D(X*x^H4K+j;wk63bXi z=JA6(*7S#B%7T>yk}LF|;hRZ$@3#iMxWnFC_uH7d%?D%$*IB)C*1u>r zKubdf5w@mfaJM=5jecoBd-aHarz#&K8B@GHC0Z7kLii`FD@>axO266eq|Vsrq#HLs zb}W`v7AVW|z`wgyncrsZ29Y)g}Zca1>W*)_E-^oDQ6l5j+rhPLY)wG(X(G`12J?cF#Fw$3CZ4 zxifBlvN^BwrEWr9Tm8G;8@s{f8?a7Cty5dMZ{d<%d5h`oGPmX3 ztKmOIZ^i4HyWd#JXXq+cB6jdyU_juF=TH6aC83Ml!=?ry8($dWh2Nb2ccf_wv}078bTA-L`|*V#ww5 zVAV9%OzF9_Eqv}?lQEf3tTh37m!&roem>ZDUOJcMqPDAE3~zJ4)%aar04yu4t(! zn~}s1^*Ow2E_`1A`%SU-xa~&eebNBkRxA;kZmV{8KW1%f({B9b?AjdLvg_Tl9`TSu zZm+k*c`1I*@0M_T2)kXyx}hi%tQ1PW{dTo8yH#i)ZScEw&d2tS@Zvz<-p;=48|&KT zJ*uIwd-X@8m2*slPahH3RvKb>^_>OxnSyua=7ZXOJBr?$8aO=5Bzzc`a{bwsqJyx% z_yR&Ok)Mx%E%A(U=vijA6xNhqmF{wbs#fr^O}W-F2QwGOT}l>j+{4P{2qC??Ui-*} z0iLA4(2>P-4gvz@%13b#H8;eAG_*T8=cQk5EIKxtznKFo1M(MCm_Cjz>xqB!P&vSD zQXW2pdQXfE3dT?5k?BcriSIJRgGGXk!&EG7wdz<7Q5Dr>1-AH{*&mafQj(m^hj?HQ zE&5v=@7wk+FCWsb2Q7TITp3{ge}G7c$ifH!YzP9762UJRo1P4Z?;YOX&wr6n0LYql z!2e>B#u09pENWmQ{4XxVegTAkfv_0>$TQL$L_MPa6B!Yi(y#%E@?Rcm2?Rv4!p#oN ze}NH!Z!e!t@i&fe4tx#Gq%JYqzrYa4#;dV!4yHrA zfiBF~3}Aij7a((d(v}i2;708DHxmp%P^`eAiW3&?Of60fq%_3MY-9hp{_q>w<`BIP z5r9pPjYv@HK`@rIL1Tdg)a>57?N3Y3e6;0#H|Pe(+^GzG zS5JO3mGzn>V6e*5ZH%w?#jS_G=gqnL{=oftMWWJnzIH5~A%j*fkurjmL+)gQ21vOQ z*d7nke(XDouDGT?u;&p8#yEWLJ5O)bFlz98+89~W|KQ>NHdh@wb$UK+z!xjH z8cbt4TUnQ5qjh`WME2n`QJ$h8kNjNqb%co)5dO_OKrncJ$&)S*Dd!4!f(+`Gr^Wme zi&E0@3q!P-b~~zuTA&e8OVJxaOJS+D272b?`BevWb3`vg!ImQ zouYOlhxJr_C`i8ABmt_=19oD~?=vJ3+m@r& zAgviQ0Q!mb$f`QD)C_p?i?K^HZ0W-d)X?6q8Fl7hzK%}Zuw1=z*n4Xz?Ykctr%m}; z-KlPy&ojUjD!LCgGNNDk0RR$=@l*bfv8Z4d)bfjQC^AdlC=%9y+qJxH+MO@w{OiXzTN+t&YVNQv*2clwp?()!1C0ZbY!&wy+y@xb2K)H+`@i z<90aTpY1%(Fbp4Bdb9C6UbY463LWmbElK_ADSl-l7YIxHs6nHm z7lFldUxG1;Bs${CBD;18z6DQs(qAuC6*csXp3c6X3RO6{?#^vPO@lDE>V%MrApn#q zGhsRh;)OT!fen-LNS~;=gEgy!#0^!TD^D*^=_rtifnajavV2)yVuzqEwxm-!_2RDp=IHCGcKX&0WK@; zK84yf$!buI$@-$cKS2~M@C!B2WQ(uK4?GjpZ8#O1ZSjmU$?gBnoI?D=YGj4D-;I&2 zilFd239Wn4)d)purnrKNa`WI9NTlZT$qTJSRmKqa<;3h}7nfau9&o(Mw&=Cr!*9ZgWN(_W*q150JVFAuSNi{Sw zf9Uk>+wLPzh>z5zJkIx~S?eK-jm}X1^9eck{fb`^%7f&Q7qmz|_vh2>_DgqNx!INe zNLaBx_e1X_#h|oO{WtetG005!XLR&PvW3 zC;kwTmD{7XghEvd^Vj+W3mt*7IT|I&Jru2RvJP@SYC4P%tco{=T*)NesJ{wXl-G~U z-`~fR{Wv?$nv-N|xfwmxDmVOblI>Bn;P5MrBxHI*d)MSX#r~B^a93%i)udG6PZIB` zn3Z|E+Z6D=W^BBhJhPnbZ70RozCa>Oe1dLnWK&tg$)d?D--SvCcx0-P%Zsw~PlkrJ zmy1Wz0YkqCv)oUT**BZ@(I4Iu0H!KuJGZWTX`*^FMf|-vSyN`#xx^y@wOMI5n zPo5A|&C8{>)%@b%uo=c;IaQpL>L7`vC?TK5E3fan=suc~AFfMX7);LN_)RY3;kA>o zo+gfNGUTvzw8F%5P4K)nk&Wj($s#@dZuGQeC}a>kjiC3rGmA_%)lD?B0A+p3pyAQ( zS4Ep>``0U`Dv$HsF0W~?ByQs_^`78erc$(~vy-Bs&cUv<&mAXY)t0J-D!DSo)+JGb zH$mI0%&ZDTGdra(()e6Yanrc5uabnz^cOckZAHd!^>yhzFYcCyA6)Ds`AUt9)oSb( zv-h)Bu%7%N_LJ2bNwk~yFxgi)J50ob9%h}~OSEgg$+D8arAwdDwwfqNm(I^lIBLC3 zuZS4QPOqICyW(1Miwh@nZ8B*X&sV%`=H8sMmg;+xpljSn}sgojWEmSo)EeA?kiD!qu>R*kG7`WTxZMJ(@ z#7`&U(FwkVf*!|Jld$+dXYj)Y#>ZMbFS{;;8mXG}Ijkn4S@d}O;bJfw%Lz$8^|+Yb zS}&<91{tQ16dZ${JYFBmvbKDB%TH#?pwHo*!rAt&_L--e$K~P1cfBuxuYw`|a8De~ z3SiVfM}@knV_KzHTC~lst$Z@~X13o`qzS*;HF{xp=#M1`4in{m zO41FGw^#WIzA8IdF`=Pmk7>yls}(3wF{dlo&eWfb ze|S`j+8j*D^_cb1z~KXLM|T-B&r3@}mdLoDlH6-b>`moquZawH$`x@+^yR1#6wT+~ z4>s3a%3Ti^EQ#=C9(kM=F3l!QjBd~O5-RSWy+CKvI2(?}64KpBbU9glGghd2v)x&@ z?6a3Rgsxk)X)u=QcX<#vBv9A3r}jk*OJHIk9fa&gTW;JfbG@BCS?PKCYS=QB`jy8v zRgW(0`&f~>Q~sv_5y~T=n%ZYd$)$>0ZNtPHCMS>3$-7-P{xsxV$oaWlu%)ATfHF6L(iU;%O%g+>pd^^I_7fl9#qhKD8}=!K?l4Gzyw^= zmfOx>2zNoXqTa}Umw|24NoPwgWqkOwWzUgpwAsf5FA`G!+J@OER1@Z;sjt;V@csK$ zUnFbm%(_(!OYhAFtM3l!FiVHB6!{ywusm@39+uFZVN#%i!SSlv`mS<~UXx24+|e5d zUYkbPrt6>5U;^2x%8mSQbr0lDt3q#2er0I7TWk=0mB7&=QJ{w3Y72n!UYTQQITi^U zVDFi@P}NMWZHl#v2Vkn3$Y7OpnBmJja#7x5i)UR0%3ax5<<4?j8~^qC*#}=fEP_(s z+xhyg+$PEb1iQr>am&%H+-*c8{d|&{jVK{tG4eJzDN`@cY&(^mphyFT-&syi{YihF z;w_@&mH!5r>0#2vo7tIIOA`Cm2021zkM|WmnF?uhJs;B!B9`~_X7S0TNr5($npMLS zVUWoM=NR=7yW5L{?|@pfenJ$SM(|E$xcta-57_3QqOSQWtvo52lutSpJSM0^HNH1d zBs#bULO_5B()&5fGt=U#q1}!CDGd)pfBnnlN5iZuG!||HaEx}gWJK)X9|0gcwNl}jk>irP_eNoU z`XGJUbnlxt7R1?whqpxeoB1>)t_$xZ!O8)=lKQGBCpkM`gTjhh>6~ zUaAZy$#ND$sngiyeZsNJdngL_ZE4rN`i`%ZeJE%Vp{mIHx+U5i5j0j5F;rq-f5Wf$ zL6+G@**M-ABLk1BUE@w(*N(B4nRr$f-RIv7bp0_>Q{UC04^&Mq*HsZ3fv7>GLEx8k z@+q$p@C*X16|SUh#2`36WNbLcn6kd-*INcNV{;WI7RE9n@r+9@#Fc}+K@g?L_8X0 z7_hY%h|x&n%#3o7|C4+txLm8O?}f5`-;L}Gp0887S7(3M^nAfQ^{DM}$xCMh1hf%3 z$tTipxxv{AX57&E^%Qt_a^zxh zi2%>3GUrWaZR2yPr&1rSdW;^dMUoj@0*eYpI(dsU?j8P=TuU*y5afztUxmP19j0}n z@Yu$$^}+3!Qt@P;+8Z{=mBobXdlF_aBN4L}2@^!B(W)|ksvu@7&7g0!D#gM10dPC2 z9ON5^EZ^Ieztv<{=Ohp|rl++-OfN3eFFOH7nc1Hi($){bDD1jjnWQBGVCSpI`F6+uspN+Uwx}!B& z!^K97+%9WJ`EyN`m%vpy2+mA&jota~A>bl{i!f}+l~IS&<537aRLs&lws*5v76;F> z`x4)on6C9G>gkBO@?Gsh^;Al<)u-#lA;PW53$DwZt%SMP7-TMmW$v+B{3teyR=&rB zt=_lcXbSg zBvNS&x;wAsIel`L0fc>Ckj6QbY`5iT(DCS4`zS26W#Hp(Hx-}4e~mI!q#IVV>L5Ma{V3kf#I>`vR^L*TaOB&| zqXeeXtL$vINv}wrJRfbBn_l1f+LBV3`cdQFVHbm*B?-4%vCidMMKY!`uE_cBq|;L> zbSm0z+w_*{#ELY}Xg5{7m?Q!86pekbM>t+1VZJ=3fhw*4#Q&o7LClf{Q|RvV&P;`g zrDB+3hF4`zqV<^6RGEQ2PV!-m!ot z-yP?u_$W|Z?9bBFEwE29$WY5&LME>{xRJ&EAPg!8HqK~L3v)5BVS{{^86H-eeHY7< zAYo#Z#30>((OMfDV<0D)mAkalAO{Uz5Mn(+&8TLJ?`BdO?rnCu?*qbG@4y&M{*C<} zY*>hkv(ZPnC!(p7xk}RVQErqFg6hauXZTZ; z=}e46azRH9VL* zk5pRnzVu#G^zE+ZZtVW?N(&x@&a2t@SLHJ;hFN;3#2zT_^^vWRXGE1QmCXHLV3?k5 zlZEeU@_qDH+=-*%AtxLuR1KMcf~K8G{WiJW zPiaD+@Md67>I`94emJ>f?~l`+d@?h5LDqwaL_v$mCCxIwbH9;*<%&v+4v3-2B2++^peeNcx|O3B9zwv*>NkGN#GyItv!6=QXkw%O*k7xIMPhIPdo8pWFNL&dmbF6wql=KQmrr{=8vkDMP;O|@(3(l z)KHt6%L;cN#DgMb_9>0X`hpOkIJa9F8F6uL=f>adaswdeqKx_u9%tLsw(}1?Ge}b& zroQL9QD%QS-qgmo9(TZURB}7VItF9B^J#X+aW_`{AcKhdBOlK*25jpVt?p8Gwsvql zOD|I4)tTd3#N%3W#L)0$8ZO*Uo=?~Nh$}Uf)~`AWRZ>R<;~k5A_=@5;zD;r4{$g3> z_smW@JM-sc7UQ124Rsg@#~M{@@x<)s7cR%X*lH@u6|g_T%CGpaT&=704yyTeq&dUu`Rx#LFTUMYP{}iG`--@bYC#&OQ_AV)5V-6v7< z)jOKZtWit-BrUyrBVsN`)q<7G3n!{WH z|4Q0xMdcvO1KjTIhI6>@gSGVXI!As>7ihXkXC-;{T50=XH}lQV(OEi$pqDhI?@gNQ z5Oej@2!k0-g(w#C3aQC_kklljow=tKs`J$GJDs)2c(Yl#tD)_2R+K)WUUxX!qoGlf zBjRr&A*JB&V&HWW=wR4^Y7)PuG27sj?{&SA5F-1Sxea(uaMLJMtk10dflFLOOx$`T z0ypl?Ien$&QsM0zEI`0O<%Y!RBDaB4cn;CevCa|cFr=D9Avw^z>t=B=lj7VvC)*B1y zn}u!|omLJ^^I_er=x`&My7?u4)ah})UspVF%YeSBz6bXsbCq525GpFxepkUdA+5!T z?0rYrRlr8g84rFCgdUHeA^GW|1eCNnLKWfuG<9|xg=%qfovcZHXR^vzpV1l3>4&Q;^(4h;+jQ~ zpFB~hIzNN5!*4mhnPXFl_8Nnx+|TfhD!d}30LDHy5tK5C>z6Oh-#MBjBxr4Xv-pdm z?BfvaK}+aN7z?k^AO#kjlNUJfAi{hxC$$cBvC^sZ);`?HuaniiuA~}w#4b<5r4a;D zVlx8F^Py#%QKHyRgo7pJ1E>3xpXy2ICSMJTNkEelTBn_>c{{8Wh|2qkeBqckz=2i~ z1J&Cg(TSl{-x6=-iI)IQE9S2)@G${1BJ9^sPSNyd%`@3LW;>$H&cQSMTuNPGDQ2o9p;GcCBRPe*etE%Aq1FrNEKB?^<9h$)XXI Date: Wed, 18 Jun 2025 14:19:48 -0700 Subject: [PATCH 14/17] update PR section --- editor.mdx | 61 +++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/editor.mdx b/editor.mdx index e4507ac62..871f7c9a2 100644 --- a/editor.mdx +++ b/editor.mdx @@ -257,63 +257,64 @@ This example shows how to add a Themes page to the Profile group. } ``` -## Pull Requests and reviewing changes - -Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation. +## Publishing changes -See how your changes will appear in visual mode. +Select the **Publish** button to save your changes and make them available. -### Creating a Pull Request on a Branch +How your changes are published depends on which branch you are working on: -1. Make your changes on a branch. -2. Click the **Publish Pull Request** button in the top-right corner of the editor. -3. Add a Pull Request Title and Description for your pull request. A good title and description will help reviewers understand the changes you've made. -4. Click **Publish Pull Request**. +* **Deployment branch**: Updates your live site immediately. +* **Other branches**: Creates a pull request so you can review changes before they go live. Publish pull request button emphasized in the Mintlify web editor Publish pull request button emphasized in the Mintlify web editor -### Reviewing Pull Requests - -You can review pull requests in your Git platform (GitHub, GitLab). - -After you create a pull request, you can see a preview deployment of the changes. - -After a reviewer approves a pull request, you can merge it to deploy the changes to your live documentation site. - +## Pull Requests and reviewing changes -## Publishing changes +Pull requests (PRs) let you propose changes from your branch so that other people can review them before merging into your live documentation. This helps ensure that your changes are correct and gives your team a chance to collaborate on content. -Select the **Publish** button to publish your changes to your live documentation site. +### Creating a pull request on a branch -The **Publish** button works differently depending on your branch: +When you're ready to publish changes from your branch: -* **Deployment branch**: Updates your live site immediately. This is usually the `main` branch. -* **Other branches**: Creates a pull request for review. +1. Make sure all your changes are saved on your branch. +1. Select **Publish Pull Request** in the top-right corner of the editor. +1. Add a title and description for your pull request. A good title and description help reviewers understand the changes you've made. +1. Select **Publish Pull Request**. The publish button emphasized in the Mintlify web editor The publish button emphasized in the Mintlify web editor +The web editor will create a pull request in your Git repository and provide a link to view it. + +### Reviewing pull requests + +Once your pull request is created: + +1. **Review your changes**: You and your team members can review your pull request in your Git provider like GitHub or GitLab. +1. **Make additional changes**: After reviewing, make any changes in your web editor. Saving your changes will update your pull request. +1. **Merge when ready**: When your pull request is ready, merge it to deploy changes to your live documentation site. + ## Troubleshooting Here are solutions to common issues you might encounter with the web editor. From 8daaf4dddf84f2a005a8962dae790cc76a8de079 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 18 Jun 2025 14:22:00 -0700 Subject: [PATCH 15/17] update troubleshooting --- editor.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/editor.mdx b/editor.mdx index 871f7c9a2..c9b993de9 100644 --- a/editor.mdx +++ b/editor.mdx @@ -320,7 +320,7 @@ Once your pull request is created: Here are solutions to common issues you might encounter with the web editor. - + **Possible causes:** - Deployment is still in progress @@ -329,10 +329,10 @@ Here are solutions to common issues you might encounter with the web editor. **Solutions:** 1. Check deployment status in your Mintlify Dashboard. - 2. Try hard refreshing your browser (Ctrl\+F5 or Cmd\+Shift\+R). + 2. Try hard refreshing your browser (Ctrl + F5 or Cmd + Shift + R). 3. Clear your browser cache. - + **Possible causes:** - Insufficient permissions to the Git repository @@ -344,7 +344,7 @@ Here are solutions to common issues you might encounter with the web editor. 2. Check if your Git integration is properly configured. 3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation. - + **Possible causes:** - Network connectivity problems From 8cd0d0d4451bda9115a4c4d06cbdd3fe86d0b3df Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 18 Jun 2025 14:30:31 -0700 Subject: [PATCH 16/17] add PR tip --- editor.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/editor.mdx b/editor.mdx index c9b993de9..5032834b7 100644 --- a/editor.mdx +++ b/editor.mdx @@ -283,6 +283,10 @@ How your changes are published depends on which branch you are working on: Pull requests (PRs) let you propose changes from your branch so that other people can review them before merging into your live documentation. This helps ensure that your changes are correct and gives your team a chance to collaborate on content. + + Even if you're working solo, pull requests are valuable for previewing changes before they go live and maintaining a clear history of updates. + + ### Creating a pull request on a branch When you're ready to publish changes from your branch: From 502aeaafc54e12234e7374ecf5671ecf78c0913c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 18 Jun 2025 17:28:04 -0700 Subject: [PATCH 17/17] add reviewer feedback --- editor.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/editor.mdx b/editor.mdx index 5032834b7..3c7d23df2 100644 --- a/editor.mdx +++ b/editor.mdx @@ -102,7 +102,7 @@ Markdown mode provides direct access to the underlying `MDX` code of your docume ## Git fundamentals -The web editor performs Git operations behind the scenes. Understanding these concepts will help you work more effectively with the web editor. +The web editor performs Git operations behind the scenes. Understanding these concepts will help you work more effectively with the web editor and collaborate with team members who are working in their local environments. @@ -135,7 +135,7 @@ The web editor performs Git operations behind the scenes. Understanding these co The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab) and handles Git automatically. When you: - **Open a file**: Fetches the latest version from your repository. -- **Make changes in a file**: Tracks your changes as a draft that can become a Git commit. +- **Make changes in a file**: Tracks your changes as a draft that can become a commit. - **Save changes**: Creates a commit with your changes. - **Create a branch**: Creates a new branch in your repository. - **Publish on your deployment branch**: Creates a commit and pushes directly to your deployment branch. @@ -160,7 +160,7 @@ Branches let you work on changes without affecting the content on your live site ### Saving changes on a branch -To save your changes on a branch, select the **Save Changes** button in the top-right corner of the editor. +To save your changes on a branch, select the **Save Changes** button in the top-right corner of the editor. This creates a commit with your changes and pushes it to your branch. ### Switching branches @@ -177,13 +177,13 @@ Edit existing content, create new pages, and organize your site structure in the ### Navigating files -Use the sidebar file explorer to browse your documentation, or select Command + P (Ctrl + P on Windows) to search for files. +Use the sidebar file explorer to browse your documentation, or press Command + P (Ctrl + P on Windows) to search for files. ### Editing content Make changes to your pages using visual mode or Markdown mode. -In visual mode, select / to open the dropdown component menu. Add content blocks, callouts, code blocks and other components to customize your documentation. +In visual mode, press / to open the dropdown component menu. Add content blocks, callouts, code blocks and other components to customize your documentation. / to open the dropdown component menu. Add con }} alt="Files menu in the web editor in dark mode."/> 1. Enter a filename. -1. Select Enter to create the file. +1. Press Enter to create the file. Your new page will open in the editor, ready for content to be added.