Skip to content

Commit e36058e

Browse files
Update 4 files
1 parent 7988cde commit e36058e

File tree

4 files changed

+29
-16
lines changed

4 files changed

+29
-16
lines changed

docs/Enabling automations.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
---
22
sidebar_position: 5
33
---
4-
5-
6-
74
# Configuring code to doc automation
85

96
This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes.
107

118
## Prereqs
129

13-
* Have an account created on https:\/\/app.docs.dev
10+
* Have an account created on https://app.docs.dev
1411

1512
* Have generated a `llm.txt` and `llmText.json` file from docs.dev
1613

docs/Overview.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
---
2-
slug: "/"
3-
title: "Welcome"
2+
slug: /
3+
title: Welcome
44
sidebar_position: 1
55
---
6-
7-
8-
96
# Welcome to Docs.dev: Your AI-powered docs assistant
107

118
Docs.dev was purpose built to help docs teams create and manage their docs. All you need to do is sync up your docs repo on GitHub and you're good to go. By leveraging AI-assisted content generation and intuitive editing tools you can significantly reduce the time and effort required to produce and maintain high-quality documentation.
@@ -14,5 +11,4 @@ Optionally, connect Docs.dev directly with your codebase to ensure that your doc
1411

1512
The following guides and resources will help you get started managing your docs with Docs.dev.
1613

17-
1814
![](/img/hero_image.png)

docs/Quickstart.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
sidebar_position: 2
33
---
4-
5-
6-
74
# Quickstart
85
Welcome to Docs.dev! Follow the steps below to get started in ***under 5 minutes***.
96

docs/automations.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
sidebar_position: 4
33
---
4-
5-
6-
74
# Automate the process in GitHub (beta)
85

96
Prevent documentation drift by automating your docs directly in the GitHub workflow
@@ -13,3 +10,29 @@ Prevent documentation drift by automating your docs directly in the GitHub workf
1310
* and more
1411

1512
This feature is in beta. Reach out directly to get set up.
13+
14+
## How it works
15+
16+
1. Connect your GitHub repository to our automation system
17+
2. Set up rules for when documentation should be updated
18+
3. Our system will automatically create or update documentation based on your code changes
19+
20+
## Benefits
21+
22+
- Always up-to-date documentation
23+
- Reduced manual work for developers
24+
- Improved consistency between code and documentation
25+
26+
## Getting started
27+
28+
To start using our GitHub automation feature:
29+
30+
1. Contact our support team to enable the beta feature for your account
31+
2. Follow the setup instructions provided by our team
32+
3. Configure your automation rules in the GitHub interface
33+
34+
For more detailed information, please refer to our [Quickstart](Quickstart.md) guide.
35+
36+
## Feedback
37+
38+
As this is a beta feature, we welcome your feedback and suggestions. Please reach out to our support team with any comments or issues you encounter while using the GitHub automation feature.

0 commit comments

Comments
 (0)