all set

Author: [email protected]

.devcontainer/devcontainer.json

@@ -2,11 +2,13 @@
   "name": "Docusaurus Project",
   "image": "mcr.microsoft.com/vscode/devcontainers/javascript-node:18",
   "forwardPorts": [3000],
-  "postCreateCommand": "npm install",
   "settings": {
     "terminal.integrated.shell.linux": "/bin/bash"
   },
     "extensions": [
         "dev-docs.dev-docs"
-   ]
+  ],
+  "features": {
+    "ghcr.io/devcontainers-community/features/deno:1": {}
+  }
 }

Enable generating codebase docs for the GitHub App.md

@@ -0,0 +1,61 @@
+
+
+  # Configuring dev-docs.json for GitHub App Documentation Generation
+
+This guide will walk you through the process of configuring the `dev-docs.json` file to enable automatic documentation generation using the Dev-Docs GitHub App.
+
+## Step 1: Locate the dev-docs.json file
+
+The `dev-docs.json` file should be located in the root directory of your repository.
+
+## Step 2: Basic Structure
+
+Ensure your `dev-docs.json` file has the following basic structure:
+
+```json
+{
+  "gitHubApp": {
+    "workflows": []
+  }
+}
+```
+
+## Step 3: Configure Workflows
+
+To enable documentation generation, add the `generateDocs` workflow to the `workflows` array:
+
+```json
+{
+  "gitHubApp": {
+    "workflows": ["generateDocs"]
+  }
+}
+```
+
+Note: The `workflows` array accepts specific enum values. Currently, the supported values are:
+
+- `generateDocs`: Enables automatic documentation generation
+- `generateChangelog`: Enables automatic changelog generation
+
+## Step 4: Additional Configuration (Optional)
+
+Depending on your project's needs, you may want to add more configuration options. For example:
+
+```json
+{
+  "ai":{
+    "contextDirs": ["src", "lib"],
+  },
+  "gitHubApp": {
+    "workflows": ["generateDocs"]
+  }
+}
+```
+
+## Step 5: Commit and Push
+
+After configuring your `dev-docs.json` and installing the GitHub app, commit the changes and push them to your repository.
+
+
+
+  

Generate High Level Context for a folder.md

@@ -0,0 +1,62 @@
+
+
+  # Using the "Generate High Level Context for the Folder" Command
+
+## Overview
+
+The "Generate High Level Context for the Folder" command is a powerful feature in Dev-Docs that allows you to automatically generate high-level documentation for an entire folder in your project. This guide will walk you through how to use this command and customize its behavior using the `dev-docs.json` configuration file.
+
+## Step-by-Step Guide
+
+### 1. Right-Click on a Folder
+In your VS Code file explorer, right-click on the folder you want to document.
+
+### 2. Select the Command
+From the context menu, choose "Generate High Level Context for the Folder".
+
+### 3. Wait for Processing
+The extension will analyze the folder contents and generate documentation. This may take a moment depending on the folder size and complexity.
+
+### 4. Review Generated Documentation
+Once complete, a new Markdown file will be created in your `dev-docs` folder, containing the high-level context for the selected folder.
+
+## Customizing with dev-docs.json
+
+You can customize the behavior of this command by modifying the `dev-docs.json` file in your project root. Here are some key configurations:
+
+### 1. Customizing the Context Prompt
+
+```json
+{
+  "ai": {
+    "contextPrompt": "your_custom_prompt_here"
+  }
+}
+```
+
+This allows you to specify a custom prompt for generating the context. You can also use a Markdown file for more complex prompts:
+
+```json
+{
+  "ai": {
+    "contextPrompt": "dev-docs/prompt.md"
+  }
+}
+```
+
+### 2. Specifying Context Directories
+
+```json
+{
+  "ai": {
+    "contextDirs": ["src", "lib", "utils"]
+  }
+}
+```
+
+This limits the context generation to specific directories, which is useful for large projects.
+
+
+
+
+  

dev-docs.json

@@ -1,11 +1,12 @@
 {
   "external": true,
   "ai": {
-    "contextDirs": [
-      "docs"
-    ],
-    "task": "dev-docs/task.md",
-    "auditTasks": ["dev-docs/audit_task_one.md"],
     "mappings": []
+  },
+  "gitHubApp": {
+    "workflows": [
+      "generateDocs",
+      "generateChangelog"
+    ]
   }
 }

dev-docs/context-.devcontainer-devcontainer.json.md

@@ -0,0 +1,26 @@
+
+
+  ---
+# High Level Context
+## context
+This file is a DevContainer configuration for a Docusaurus project. It defines the development environment for use with Visual Studio Code's Remote - Containers feature or GitHub Codespaces. Key aspects include:
+
+1. It uses a Node.js 18 base image
+2. It forwards port 3000 for local development
+3. It automatically installs dependencies using npm
+4. It sets the default shell to bash
+5. It includes the Dev Docs extension
+6. It adds Deno as an additional feature to the container
+
+This configuration ensures a consistent development environment across different machines and simplifies the setup process for new contributors to the Docusaurus project.
+
+---
+# Docusaurus Project .devcontainer/devcontainer.json
+## Imported Code Object
+I apologize, but I cannot provide an explanation based on the code snippet you've provided. The snippet "[object Object]" is not actual code, but rather a string representation of a JavaScript object that has been improperly converted to a string.
+
+To get a meaningful explanation, you would need to provide the actual code or configuration related to the Docusaurus project. Docusaurus is a static site generator for creating documentation websites, but without seeing the specific code or configuration, I cannot provide any details about how it's being used in your particular case.
+
+If you have a specific code snippet or configuration file related to Docusaurus, please share that, and I'll be happy to explain it.
+
+  

dev-docs/context-docs-Dev-Docs-Quickstart.md.md

@@ -0,0 +1,16 @@
+
+
+  ---
+# High Level Context
+## context
+This file, "Dev-Docs-Quickstart.md", is a Markdown document that serves as a quickstart guide for using the Dev-Docs tool. It provides step-by-step instructions for new users to get started with Dev-Docs in about five minutes. The guide covers:
+
+1. Creating an account on dev-docs.io
+2. Opening a sample repo in GitHub Codespaces
+3. Installing and setting up the Dev-Docs extension in VS Code
+4. Generating onboarding documentation for a code file
+5. Creating user-facing documentation
+
+The document includes visual aids (images) to help users follow along with each step. It also briefly explains how Dev-Docs works, mentioning the `dev-docs.json` configuration file and the tool's customization capabilities. This quickstart guide is designed to give users a quick and practical introduction to the Dev-Docs platform and its core features.
+
+  

dev-docs/context-docs-Initial-Setup-Install-VS-Code-Extension-and-Get-Started.md.md

@@ -0,0 +1,8 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file is a guide for installing the Dev-Docs VS Code extension. It appears to be part of a documentation website, likely built with a static site generator that uses frontmatter (such as Docusaurus, given the 'sidebar_position' metadata). The document provides a step-by-step tutorial with visual aids (screenshots) to help users install the extension in Visual Studio Code. It's structured in a clear, user-friendly manner, making it easy for developers to follow along and set up the Dev-Docs extension in their VS Code environment.
+
+  

dev-docs/context-docs-Initial-Setup-Sign-in-With-The-VS-Code-Extension.md.md

@@ -0,0 +1,14 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides instructions for users to sign in to the Dev-Docs extension in Visual Studio Code. It is part of an initial setup guide, specifically focused on authenticating users within the VS Code environment. The document outlines a three-step process:
+
+1. Locating the Dev-Docs login button in VS Code
+2. Clicking the Sign In button to initiate the login process
+3. Selecting the user's organization from a dropdown menu
+
+The file includes images to visually guide users through each step, making the process more accessible. The sidebar_position metadata suggests this is part of a larger documentation structure, likely the third item in a series of setup instructions.
+
+  

dev-docs/context-docs-Initial-Setup-_category_.json.md

@@ -0,0 +1,14 @@
+
+
+  ---
+# High Level Context
+## context
+This JSON file is likely part of a documentation system or website structure, possibly using a framework like Docusaurus. It defines metadata for a category of documentation called "Initial Setup":
+
+1. The "label" field sets the display name for this category.
+2. The "position" field (value 3) probably determines the order in which this category appears relative to others.
+3. The "link" object with "type": "generated-index" suggests that an index page will be automatically generated for this category, listing its contents.
+
+This file helps organize and structure the documentation, making it easier for users to navigate and find information about the initial setup process for the documented project or system.
+
+  

dev-docs/context-docs-Internal-Docs-Customize-Your-AI-Generation.md.md

@@ -0,0 +1,18 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides instructions for customizing AI-generated documentation in the Dev-Docs VS Code extension. It covers the following key steps:
+
+1. Signing into Dev-Docs in VS Code
+2. Selecting an organization
+3. Locating the dev-docs.json configuration file
+4. Customizing the JSON configuration to tailor AI-generated documentation
+5. Running the AI documentation generation on a chosen code file
+
+The file explains how to modify the dev-docs.json file to include custom questions for the AI to answer about the code, set accepted file extensions, and configure whether documentation should be generated automatically on save. It also provides instructions on how to manually trigger documentation generation using the command palette or keyboard shortcut.
+
+Overall, this guide helps users personalize their AI-assisted documentation process within the Dev-Docs extension.
+
+