Skip to content

Commit 056f700

Browse files
Updated developer docs: 2025-03-06T23:25:58+0000 Dev-Docs update
1 parent 1991901 commit 056f700

3 files changed

+49
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This Markdown file provides a step-by-step guide for users to connect their existing documentation repository to the Docs.dev platform. The document outlines the process of:
7+
8+
1. Setting up a Docs.dev account
9+
2. Installing the Dev-Docs GitHub App
10+
3. Selecting and configuring the appropriate GitHub repository
11+
4. Associating the repository with the Docs.dev organization
12+
5. Finalizing the setup within the Docs.dev web application
13+
14+
The guide includes screenshots for each step, making it easier for users to follow along. It's designed to help users integrate their existing documentation seamlessly with the Docs.dev editor, enabling them to manage and update their documentation through the platform.
15+
16+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This Markdown file provides a step-by-step guide for users to set up a new documentation repository using a starter template and connect it to the Docs.dev AI editor. The process involves:
7+
8+
1. Initiating setup in Docs.dev
9+
2. Creating a new repository on GitHub using a provided template
10+
3. Configuring the repository details
11+
4. Installing and setting up the Dev-Docs GitHub App
12+
5. Connecting the new repository to the Docs.dev platform
13+
6. Associating the repository with a Docs.dev organization
14+
15+
The guide includes detailed instructions for each step, along with accompanying screenshots to help users navigate the process. It covers interactions between the Docs.dev platform and GitHub, ensuring users can successfully create, configure, and connect their documentation repository to the AI editor.
16+
17+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This Markdown file provides documentation on advanced AI tools for generating and managing documentation using Docs.dev AI. It covers several features:
7+
8+
1. Audit docs: AI-powered scanning of existing docs for improvements or changes.
9+
2. Analyze docs: Evaluating the quality of documentation for different user personas.
10+
3. Generate content: Creating new docs based on existing documentation and codebases.
11+
4. Generate docs from code objects: Producing documentation for specific code objects in a codebase or SDK.
12+
5. Generate complete docs: Creating a full set of documentation pages for projects without existing documentation.
13+
14+
Each section explains the purpose of the tool and provides step-by-step instructions on how to use it within the Docs.dev web editor. The file emphasizes that all AI-generated content can be further edited before being pushed to GitHub.
15+
16+

0 commit comments

Comments
 (0)