Skip to content

Commit 03569de

Browse files
ricardonunez-ioricardonunez-io
committed
Update current web editor docs
1 parent 2c43f70 commit 03569de

File tree

4 files changed

+96
-121
lines changed

4 files changed

+96
-121
lines changed

‎changelog/overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mode: "wide"
88
## Web Editor
99
We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.
1010

11-
Check out our [docs on getting started with Web Editor](/webeditor).
11+
Check out our [docs on getting started with Web Editor](/web-editor).
1212

1313
## llms.txt
1414
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

‎mint.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
"pages": [
6262
"quickstart",
6363
"development",
64-
"webeditor",
6564
"settings/global",
6665
"settings/navigation",
6766
"web-editor",

‎web-editor.mdx‎

Lines changed: 95 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,16 @@ icon: 'pen-to-square'
55
---
66

77
<Warning>
8-
The Web Editor is currently in beta. We are in the process of adding additional
8+
Mintlify Web Editor is currently in beta. We are in the process of adding additional
99
features and fixing bugs. We'd love to get your feedback on what we can improve.
1010

1111
Email us at [[email protected]](mailto:[email protected])
1212
</Warning>
1313

14-
The Web Editor is the preferred way to edit docs directly without having to open
15-
your IDE and run `mintlify dev`.
14+
Web Editor is the preferred way to edit docs directly without having to open your IDE or run `mintlify dev`.
1615

17-
The editor includes a few key features to integrate directly into your existing
18-
git workflow, like creating branches, pull requests, commits, and diffs for your
19-
current changes.
16+
The editor includes a few key features to integrate directly into your existing git workflow,
17+
like creating branches, pull requests, commits, and diffs for your current changes.
2018

2119
It also includes a fully editable experience for changing and adding content directly,
2220
even with custom components.
@@ -25,70 +23,106 @@ If you understand git workflows and our integrations already, you can skip to [h
2523

2624
## Git and update workflows
2725

28-
In order to make updates to your docs, we include a few buttons specifically to
29-
integrate with your git workflow.
30-
31-
### Creating new branches
32-
33-
In order to make changes to your docs, you might want to change from the main branch
34-
to avoid publishing directly to your main docs site.
35-
36-
To do this, you can open the branches modal on the top left of the editor.
37-
38-
<Frame>
39-
<img src="/images/editor/branches-light.png" className="block dark:hidden" />
40-
<img src="/images/editor/branches-dark.png" className="hidden dark:block" />
41-
</Frame>
26+
### Git basics
4227

43-
From here, you can either switch to a different git branch than `main`, or you can
44-
create a new branch by clicking the **"New Branch"** button.
28+
While Web Editor means you don’t need to go to GitHub or your command line to make
29+
changes, it’s still helpful to know the basics of git.
4530

46-
<Frame>
47-
<img src="/images/editor/new-branch-light.png" className="block dark:hidden" />
48-
<img src="/images/editor/new-branch-dark.png" className="hidden dark:block" />
49-
</Frame>
31+
Git terminology:
5032

51-
After you create a new branch, you'll automatically be switched, and all changes
52-
you make will be made to this new branch until you change branches again or reload the page.
33+
- **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub).
5334

54-
By default, when you load the page again, you'll default to the main branch.
35+
- **Commit**: A snapshot of changes made to files in the repository.
5536

56-
### Making a commit
37+
- **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.
5738

58-
In order to make a commit, you have two options, both of which appear on the top
59-
right of the editor:
39+
- **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.
6040

61-
1. If you're on the main branch of your docs repository, you can push a commit
62-
directly to the repo by clicking the **"Publish"** button. You'll see your changes
63-
reflect in your git branch the next time you run `git pull`.
41+
### Making updates
6442

65-
<Frame>
66-
<img src="/images/editor/publish-button-light.png" className="block dark:hidden" />
67-
<img src="/images/editor/publish-button-dark.png" className="hidden dark:block" />
68-
</Frame>
69-
70-
2. If you're not on the main branch, you can push a commit to your branch by clicking
71-
on the "Save changes" button. If you're ready to publish a pull request to put your branch
72-
up for review, you can click the "Publish Pull Request" button.
73-
74-
<Frame>
75-
<img src="/images/editor/pull-request-button-light.png" className="block dark:hidden" />
76-
<img src="/images/editor/pull-request-button-dark.png" className="hidden dark:block" />
77-
</Frame>
78-
79-
This will create the pull request for you on GitHub using the branch you selected onto
80-
your main branch.
81-
82-
### Making a pull request
83-
84-
3. If you do put your pull request up for review, you can edit the title and description
85-
of the PR, but a default Mintlify title will be provided for you if you leave it
86-
empty.
43+
In order to make updates to your docs, we include a few buttons specifically to
44+
integrate with your git workflow.
8745

88-
<Frame>
89-
<img src="/images/editor/pr-modal-light.png" className="block dark:hidden" />
90-
<img src="/images/editor/pr-modal-dark.png" className="hidden dark:block" />
91-
</Frame>
46+
<Note>
47+
If you haven't done so already, please install the Mintlify GitHub app to your GitHub account.
48+
You can find [documentation here](#1-deploying-your-docs-repository), or you can install
49+
the app in the [GitHub App page](https://dashboard.mintlify.com/settings/organization/github-app)
50+
page of the dashboard.
51+
</Note>
52+
53+
<Steps>
54+
<Step title="Creating new branches">
55+
In order to make changes to your docs, you might want to change from the main branch
56+
to avoid publishing directly to your main docs site.
57+
58+
To do this, you can open the branches modal on the top left of the editor.
59+
60+
<Frame>
61+
<img src="/images/editor/branches-light.png" className="block dark:hidden" />
62+
<img src="/images/editor/branches-dark.png" className="hidden dark:block" />
63+
</Frame>
64+
65+
From here, you can either switch to a different git branch than `main`, or you can
66+
create a new branch by clicking the **"New Branch"** button.
67+
68+
<Frame>
69+
<img src="/images/editor/new-branch-light.png" className="block dark:hidden" />
70+
<img src="/images/editor/new-branch-dark.png" className="hidden dark:block" />
71+
</Frame>
72+
73+
After you create a new branch, you'll automatically be switched, and all changes
74+
you make will be made to this new branch until you change branches again or reload the page.
75+
76+
By default, when you load the page again, you'll default to the main branch.
77+
78+
<Tip>
79+
As a best practice, you should always create a new branch to make changes so you can submit a pull request for review by other teammates. You also may not have permissions to make changes to the main branch, in which case we'll try to open a pull request for you.
80+
</Tip>
81+
</Step>
82+
83+
<Step title="Making a commit">
84+
In order to make a commit, you have two options, both of which appear on the top
85+
right of the editor:
86+
87+
<Tabs>
88+
<Tab title="Main branch">
89+
If you're on the main branch of your docs repository, you can push a commit
90+
directly to the repo by clicking the **"Publish"** button. You'll see your changes
91+
reflect in your git branch the next time you run `git pull`.
92+
93+
<Frame>
94+
<img src="/images/editor/publish-button-light.png" className="block dark:hidden" />
95+
<img src="/images/editor/publish-button-dark.png" className="hidden dark:block" />
96+
</Frame>
97+
</Tab>
98+
99+
<Tab title="Different branch">
100+
If you're not on the main branch, you can push a commit to your branch by clicking
101+
on the "Save changes" button. If you're ready to publish a pull request to put your branch
102+
up for review, you can click the "Publish pull request" button.
103+
104+
<Frame>
105+
<img src="/images/editor/pull-request-button-light.png" className="block dark:hidden" />
106+
<img src="/images/editor/pull-request-button-dark.png" className="hidden dark:block" />
107+
</Frame>
108+
</Tab>
109+
</Tabs>
110+
111+
This will create the pull request for you on GitHub using the branch you selected onto
112+
your main branch.
113+
</Step>
114+
115+
<Step title="Making a pull request">
116+
If you do put your pull request up for review, you can edit the title and description
117+
of the PR, but a default Mintlify title will be provided for you if you leave it
118+
empty.
119+
120+
<Frame>
121+
<img src="/images/editor/pr-modal-light.png" className="block dark:hidden" />
122+
<img src="/images/editor/pr-modal-dark.png" className="hidden dark:block" />
123+
</Frame>
124+
</Step>
125+
</Steps>
92126

93127
## Editing content
94128

‎webeditor.mdx‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

0 commit comments

Comments
 (0)