Skip to content

Commit 3a8b1af

Browse files
updates setup
1 parent 491794f commit 3a8b1af

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

docs/external-docs/Setup your user facing docs.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,32 @@
33
## Step 1: Access Dev-Docs interface
44
![Dev-Docs interface](/img/setup_your_user_facing_docs/step_3.png)
55

6-
Open the Dev-Docs interface. You'll see options on the left sidebar including "Sign Out", "Setup my repo", "Generate Context", etc. The main panel shows "Get started with Dev-Docs" with instructions to follow.
6+
Click the Dev-Docs icon on the left sidebar.
77

88
## Step 2: Turn on Markdown Mode
99
![Turn on Markdown Mode](/img/setup_your_user_facing_docs/step_4.png)
1010

11-
Under "Get started with Dev-Docs", click the "Run Command" button next to "Turn on Markdown Mode". This enables writing documentation locally using Markdown.
11+
Click "view your connected docs".
1212

1313
## Step 3: Review setup progress
1414
![Review setup progress](/img/setup_your_user_facing_docs/step_5.png)
1515

16-
After turning on Markdown Mode, you'll see a checkmark next to "Mark Done". The next step "Open Dev-Docs" is now available.
17-
18-
## Step 4: Check for existing docs repo
19-
![Check for existing docs repo](/img/setup_your_user_facing_docs/step_6.png)
20-
2116
If you don't have an existing docs repository, you'll see a message: "No docs repo found. Please go to https://dev-docs.io/users_docs". Click the "Open" button to proceed.
2217

23-
## Step 5: Access your user-facing documentation site
24-
![Access user-facing documentation site](/img/setup_your_user_facing_docs/step_7.png)
18+
## Step 4: Access your user-facing documentation site
19+
![Access user-facing documentation site](/img/setup_your_user_facing_docs/step_6.png)
2520

26-
You'll be taken to your user-facing documentation site. Here you can manage your documentation with Dev-Docs. The page shows options for setting up GitHub, editing docs, and deploying your site.
21+
This will open the Dev-Docs web app, where a "docusaurus" template will be generated for you. Once generated you can click on the GitHub link.
2722

28-
## Step 6: Setup GitHub repository
23+
## Step 5: Setup GitHub repository
2924
![Setup GitHub repository](/img/setup_your_user_facing_docs/step_8.png)
3025

3126
Click on the "GitHub setup" button to connect your documentation to a GitHub repository.
3227

33-
## Step 7: Accept collaboration invitation
28+
## Step 6: Accept collaboration invitation
3429
![Accept collaboration invitation](/img/setup_your_user_facing_docs/step_9.png)
3530

36-
You'll receive an invitation to collaborate on the GitHub repository. Click "Accept invitation" to gain access to the repository.
37-
38-
## Step 8: Confirm collaboration
39-
![Confirm collaboration](/img/setup_your_user_facing_docs/step_10.png)
31+
You'll receive an invitation to collaborate on the GitHub repository. Click "Accept invitation" to gain access to the repository. Now you are done and any of your user-facing docs generated by the Vs Code Extension will be pushed up to that documentation repo. Additionally if you want to bring your own existing docs repo navigate back to "https://dev-docs.io/users_docs" to customize.
4032

41-
After accepting the invitation, you'll see the collaboration confirmation page. You now have access to edit and manage the documentation repository on GitHub.
4233

4334

0 commit comments

Comments
 (0)