|
3 | 3 | ## Step 1: Access Dev-Docs interface |
4 | 4 |  |
5 | 5 |
|
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. |
7 | 7 |
|
8 | 8 | ## Step 2: Turn on Markdown Mode |
9 | 9 |  |
10 | 10 |
|
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". |
12 | 12 |
|
13 | 13 | ## Step 3: Review setup progress |
14 | 14 |  |
15 | 15 |
|
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 | | - |
20 | | - |
21 | 16 | 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. |
22 | 17 |
|
23 | | -## Step 5: Access your user-facing documentation site |
24 | | - |
| 18 | +## Step 4: Access your user-facing documentation site |
| 19 | + |
25 | 20 |
|
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. |
27 | 22 |
|
28 | | -## Step 6: Setup GitHub repository |
| 23 | +## Step 5: Setup GitHub repository |
29 | 24 |  |
30 | 25 |
|
31 | 26 | Click on the "GitHub setup" button to connect your documentation to a GitHub repository. |
32 | 27 |
|
33 | | -## Step 7: Accept collaboration invitation |
| 28 | +## Step 6: Accept collaboration invitation |
34 | 29 |  |
35 | 30 |
|
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 | | - |
| 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. |
40 | 32 |
|
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. |
42 | 33 |
|
43 | 34 |
|
0 commit comments