diff --git a/web-editor.mdx b/web-editor.mdx index 0c945d94b..3f582fb54 100644 --- a/web-editor.mdx +++ b/web-editor.mdx @@ -22,17 +22,17 @@ changes, it's still helpful to know the basics of git. Git terminology: -- **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub). +* **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub). -- **Commit**: A snapshot of changes made to files in the repository. +* **Commit**: A snapshot of changes made to files in the repository. -- **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. +* **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version. -- **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. +* **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live. ### Making updates -In order to make updates to your docs, we include a few buttons specifically to +In order to make updates to your docs, we include a few buttons specifically to integrate with your git workflow. @@ -51,6 +51,7 @@ integrate with your git workflow. + @@ -59,6 +60,7 @@ integrate with your git workflow. + @@ -84,6 +86,7 @@ integrate with your git workflow. + @@ -95,6 +98,7 @@ integrate with your git workflow. + @@ -111,6 +115,7 @@ integrate with your git workflow. + @@ -125,6 +130,7 @@ commands you have access to after typing `/` in the **"Visual Editor"** mode: + @@ -132,6 +138,7 @@ As you type, you'll see more options pop up: + @@ -179,6 +186,7 @@ image or use an existing image from the repo. + @@ -186,6 +194,7 @@ Uploading an image can be done through the modal: + @@ -193,6 +202,7 @@ And you can preview an existing image before you add it. + @@ -203,6 +213,7 @@ and **"Edit"** buttons on the top right of the image. + @@ -210,6 +221,7 @@ Clicking the **"Edit"** button lets you edit the attributes of the image. + @@ -223,6 +235,7 @@ In order to offer the most flexibility, the editor has three modes: + @@ -239,10 +252,10 @@ you'd do in your IDE. This offers less flexibility, in that our components aren' for auto-complete, but it does have two unique advantages. 1. It allows you to edit props of components (see our [limitations below](#current-limitations)) -which is currently not available in **"Visual Editor"** mode yet. + which is currently not available in **"Visual Editor"** mode yet. 2. It allows you to correct syntax errors which might've appeared in your repo that -might not be compatible with **"Visual Editor"** mode until you've fixed them. + might not be compatible with **"Visual Editor"** mode until you've fixed them. ### Diff View @@ -268,8 +281,7 @@ We do have a few current limitations in the editor that we're working to resolve - We currently don't show any previews for OpenAPI specs. This is on our roadmap to support - as a read-only preview. + We currently don't show any previews for OpenAPI specs. Read-only previews are currently on our roadmap to support.