Skip to content

Commit a32681c

Browse files
committed
Updated developer docs: 2025-03-06T20:03:07+0000
1 parent 245ccb2 commit a32681c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/Quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ sidebar_position: 2
88
Welcome to Docs.dev! Follow the steps below to get started in ***under 5 minutes***.
99

1010
## Prerequisites
11-
* A GitHub account is required for authenticating with [Docs.dev](http://Docs.dev)
11+
* A GitHub account for authenticating with [Docs.dev](http://Docs.dev).
1212
* A documentation repo in GitHub. If you do not have one, go [here](/docs/editor/connect-the-starter-template-to-the-ai-editor) and follow the guide to set up a new docs repo using our open source Docusaurus template
1313

1414
## Create account
1515
Go to [app.docs.dev](http://app.docs.dev) and log in with GitHub to create your account and create an org within Docs.dev.
1616

1717
## Setup and connect your docs repo
18-
Click setup to go through the onboarding and connect your existing docs repo in GitHub. If you do not have an existing docs repo, you can either create one yourself and connect it or leverage our open source Docusaurus template by following the instructions [here](/docs/editor/connect-the-starter-template-to-the-ai-editor)
18+
Click setup to go through the onboarding and connect your existing docs repo in GitHub. If you do not have an existing docs repo, you can either create one yourself and connect it or leverage our open source Docusaurus template by following the instructions [here](/docs/editor/connect-the-starter-template-to-the-ai-editor).
1919

2020
### Connect your existing docs
2121
Select **Connect your own docs** to set up Docs.dev to work with your existing documentation. You will be taken to GitHub to install our GitHub App and will need to connect it to your documentation repo. You will need the repository owner to approve the request if you lack the permissions needed to install GitHub Apps on your repo.

docs/managingcontent/webeditor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 1
33
---
44

55
# Create and manage content
6-
Use the [Docs.dev](http://Docs.dev) web editor to generate new content and manage your existing docs directly with your existing workflow. Once connected with your docs repo on GitHub (see Quickstart \[LINK]), all your markdown docs will be viewable and editable directly in a rich text editor. Use the editor to create new drafts, edit existing content, leverage AI assisted writing capabilities, and more. Everything you do will be pushed back to the GitHub branch of your choosing as markdown or mdx, where you can edit and continue with your normal editing and publishing workflow.
6+
Use the [Docs.dev](http://Docs.dev) web editor to generate new content and manage your existing docs directly with your existing workflow. Once connected with your docs repo on GitHub (see [Quickstart](https://learn.docs.dev/docs/Quickstart)), all your markdown docs will be viewable and editable directly in a rich text editor. Use the editor to create new drafts, edit existing content, leverage AI assisted writing capabilities, and more. Everything you do will be pushed back to the GitHub branch of your choosing as markdown or mdx, where you can edit and continue with your normal editing and publishing workflow.
77

88
Below you'll see some information on how the web editor works and some of the basic functionality of it. Refer to the additional docs to learn how to leverage the more advanced AI functionality that Docs.dev has to offer.
99

@@ -43,4 +43,4 @@ You can always go back to GitHub to view the doc you have open by selecting the
4343
Select the three dots next to your drafts on the left hand side of the web editor screen to rename or delete drafts. You can select multiple drafts by clicking the three lines button between where it says **Drafts** and the **Search** button (magnifying glass).
4444

4545
## View raw markdown content
46-
Select the **Rich text editor **dropdown in the top right and select **Raw markdown** to view the raw markdown that your doc will be pushed to GitHub as. We do not offer functionality to edit in raw markdown from the web editor today but you can always do so directly in GitHub, in a local environment or however you choose.
46+
Select the **Rich text editor** dropdown in the top right and select **Raw markdown** to view the raw markdown that your doc will be pushed to GitHub as. We do not offer functionality to edit in raw markdown from the web editor today but you can always do so directly in GitHub, in a local environment or however you choose.

0 commit comments

Comments
 (0)