Merge branch 'main' of https://github.com/team-dev-docs/devdocsprod-dev-docs

avb-is-me · avb-is-me · commit 374449aee034 · 2025-01-10T23:16:36.000Z
diff --git a/dev-docs/context-docs-Enable Workflows with the GitHub app.md.md b/dev-docs/context-docs-Enable Workflows with the GitHub app.md.md
@@ -0,0 +1,19 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides instructions on how to enable and configure automated workflows for generating internal documentation and changelogs using a GitHub App. The document outlines the following key points:
+
+1. It explains how to modify the Dev-Docs.json configuration file to enable these features.
+2. It describes the steps to locate and edit the Dev-Docs.json file.
+3. It shows how to configure which workflows to enable using the `Workflow` enum.
+4. It demonstrates how to set up an optional changelog location.
+5. It provides a JSON configuration example for reference.
+6. It explains how to enable specific workflows for generating docs and changelogs.
+7. It mentions how to specify the location for generated changelogs.
+8. It includes important notes about proper JSON formatting and automatic detection by the GitHub App.
+
+This guide is intended for developers or project maintainers who want to automate their documentation and changelog generation processes using a GitHub App integration.
+
+  
diff --git a/dev-docs/context-docs-editor-Add a table.md.md b/dev-docs/context-docs-editor-Add a table.md.md
@@ -0,0 +1,8 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to add a table to a document using a specific editor or application. The instructions are presented in a clear, numbered format with accompanying images for each step. The guide covers the entire process, from positioning the cursor to inserting the table, editing column headers, and adding content. It's designed to be an easy-to-follow tutorial for users who may be unfamiliar with the table insertion feature in this particular editing tool.
+
+  
diff --git a/dev-docs/context-docs-editor-Add an image.md.md b/dev-docs/context-docs-editor-Add an image.md.md
@@ -0,0 +1,23 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to add an image to a document using a specific editor or content management system. The guide is structured in 11 steps, each with a descriptive title, an accompanying image, and a brief explanation of the action to be taken.
+
+The process covers:
+1. Selecting the location for the image
+2. Accessing formatting options
+3. Choosing the "Add Image" option
+4. Interacting with the image upload dialog
+5. Specifying the folder location for the image
+6. Naming the image
+7. Initiating the upload process
+8. Selecting the image file from the user's computer
+9. Monitoring the upload progress
+10. Observing the image placeholder in the document
+11. Viewing the final result with the image displayed in the document
+
+Each step is illustrated with a screenshot, making it easy for users to follow along visually. The file is designed to be a comprehensive, user-friendly guide for adding images to documents within the specific editor or system.
+
+  
diff --git a/dev-docs/context-docs-editor-Add and edit frontmatter.md.md b/dev-docs/context-docs-editor-Add and edit frontmatter.md.md
@@ -0,0 +1,16 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to add and edit frontmatter in a document editor, likely for a content management system or static site generator. The guide consists of 12 steps, each accompanied by a screenshot, detailing the process of:
+
+1. Opening the metadata drawer
+2. Accessing the "File metadata" section
+3. Adding new parameters (specifically "title" and "author")
+4. Inputting values for these parameters
+5. Saving the changes
+
+The instructions are clear and concise, making it easy for users to understand how to manipulate frontmatter data in their documents. This guide is particularly useful for content creators or developers who need to manage metadata for their files within the system.
+
+  
diff --git a/dev-docs/context-docs-editor-Audit your docs.md.md b/dev-docs/context-docs-editor-Audit your docs.md.md
@@ -0,0 +1,24 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to conduct an audit of documentation using a specific documentation management tool or platform. The process includes:
+
+1. Accessing the audit feature
+2. Selecting documents to audit
+3. Choosing the audit scope
+4. Specifying audit criteria
+5. Reviewing audit options
+6. Initiating the audit
+7. Viewing and analyzing audit results
+8. Selecting issues to address
+9. Preparing for modifications
+10. Copying affected pages to drafts
+11. Monitoring the copy process
+12. Reviewing updated drafts
+13. Making necessary changes
+
+The guide is designed to help users identify inconsistencies, gaps, or other issues in their documentation and provides a workflow for addressing these issues through a draft-and-edit process. Each step is accompanied by a screenshot to visually guide users through the process.
+
+  
diff --git a/dev-docs/context-docs-editor-Generate content from existing content.md.md b/dev-docs/context-docs-editor-Generate content from existing content.md.md
@@ -0,0 +1,19 @@
+
+
+  ---
+# High Level Context
+## context
+This markdown file provides a step-by-step guide on how to generate new content based on existing documentation using an AI-powered content generation tool. The process involves:
+
+1. Accessing the content generation interface
+2. Selecting existing documents as context
+3. Specifying the task or prompt for content generation
+4. Submitting the request and waiting for the AI to generate content
+5. Reviewing, editing, and refining the generated content
+6. Formatting and structuring the new content
+7. Adding additional information as needed
+8. Finalizing and publishing the new document
+
+The guide includes 16 steps, each accompanied by a screenshot to visually demonstrate the process. It emphasizes that the generated content should be used as a starting point and encourages users to customize and refine the output to meet their specific documentation needs.
+
+  
diff --git a/dev-docs/context-docs-editor-Generate content from your codebase and docs.md.md b/dev-docs/context-docs-editor-Generate content from your codebase and docs.md.md
@@ -0,0 +1,19 @@
+
+
+  ---
+# High Level Context
+## context
+This markdown file provides a step-by-step guide for setting up and using the Dev-Docs GitHub App to generate content from a user's codebase and documentation. The process involves:
+
+1. Authorizing and installing the Dev-Docs GitHub App
+2. Configuring repository access
+3. Accessing the content generation interface
+4. Selecting context from existing documentation or code files
+5. Generating and reviewing AI-created content
+6. Refining and iterating on the generated content
+7. Adding additional context if needed
+8. Finalizing and saving the generated content to documentation
+
+The guide includes visual aids (images) for each step, making it easier for users to follow along and understand the process of leveraging AI to create documentation based on their existing codebase and docs.
+
+  
diff --git a/dev-docs/context-docs-editor-View raw markdown content.md.md b/dev-docs/context-docs-editor-View raw markdown content.md.md
@@ -0,0 +1,15 @@
+
+
+  ---
+# High Level Context
+## context
+This markdown file provides a step-by-step guide on how to view and edit raw markdown content in a document editor. The guide includes:
+
+1. Instructions for switching from rich text editor mode to raw editor mode
+2. Steps to locate and use the dropdown menu for changing editor modes
+3. Explanation of how to view and edit raw markdown directly
+4. Instructions for switching back to the rich text editor mode
+
+Each step is accompanied by a numbered heading and an image illustrating the action to be taken. The guide is designed to be user-friendly and easy to follow, allowing users to toggle between rich text and raw markdown views of their documents.
+
+  
diff --git a/dev-docs/context-docs-editor-_category_.json.md b/dev-docs/context-docs-editor-_category_.json.md
@@ -0,0 +1,13 @@
+
+
+  ---
+# High Level Context
+## context
+This JSON file appears to be a configuration file for a documentation system or content management system. It defines metadata for a category or section in the documentation structure. The file specifies:
+
+1. A position value of 5, which likely determines the order in which this category appears relative to other categories.
+2. A label "Web rich text editor", which is probably used as the display name for this category in the documentation navigation or menu.
+
+This file is likely used to organize and structure documentation related to a web-based rich text editor component or feature within a larger documentation system.
+
+  
diff --git a/dev-docs/context-docs-editor-add a new draft.md.md b/dev-docs/context-docs-editor-add a new draft.md.md
@@ -0,0 +1,17 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to add a new draft in a document editing interface. The instructions are broken down into six steps, each accompanied by a screenshot for visual reference. The process includes:
+
+1. Opening the drafts section
+2. Clicking to add a new draft
+3. Starting to type the draft content
+4. Automatic saving of the draft
+5. Continuing to edit the draft
+6. Confirming that the draft is stored as markdown in a connected repository
+
+The guide emphasizes the ease of use, automatic saving features, and the integration with a markdown-based documentation system. It's designed to help users quickly understand how to create and manage drafts within the editor interface.
+
+  
diff --git a/dev-docs/context-docs-editor-delete a draft.md.md b/dev-docs/context-docs-editor-delete a draft.md.md
@@ -0,0 +1,18 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides step-by-step instructions on how to delete a draft document in a document editor application. The content is structured as follows:
+
+1. It starts with a title explaining the purpose of the document.
+2. It then breaks down the process into three clear steps:
+   - Navigating to the Drafts section
+   - Selecting the draft to delete
+   - Clicking the Delete button
+
+Each step is accompanied by a descriptive text and a reference to an image that visually demonstrates the action. The file uses Markdown syntax for formatting, including headers, image links, and emphasis.
+
+The document is designed to be user-friendly, guiding users through the process of deleting a draft with clear instructions and visual aids. It also includes a cautionary note at the end, reminding users that deleting a draft is a permanent action.
+
+  
diff --git a/dev-docs/context-docs-editor-generate a llm.txt file.md.md b/dev-docs/context-docs-editor-generate a llm.txt file.md.md
@@ -0,0 +1,15 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to generate a llm.txt file using a specific interface or application. The document outlines four main steps:
+
+1. Opening the Create/Update Dialog
+2. Locating the File Location Field
+3. Entering the File Location
+4. Generating the File
+
+Each step is accompanied by a brief description and a corresponding image to illustrate the process visually. The guide is designed to be user-friendly, walking the reader through the process of specifying where they want the llm.txt file to be created or updated, and then generating it. The example given uses "static/films" as the file location, suggesting this might be related to a film or media management system.
+
+  
diff --git a/dev-docs/context-docs-editor-merge your drafts to another branch.md.md b/dev-docs/context-docs-editor-merge your drafts to another branch.md.md
@@ -0,0 +1,22 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides a step-by-step guide on how to merge drafts to another branch in a documentation or content management system. The document is structured as a tutorial with 11 steps, each accompanied by a screenshot to illustrate the process visually. The steps cover:
+
+1. Opening the drafts menu
+2. Viewing draft contents
+3. Accessing the "Push to GitHub" feature
+4. Selecting drafts to push
+5. Choosing specific drafts
+6. Confirming the selection
+7. Selecting the target branch
+8. Choosing the specific target branch
+9. Confirming the branch selection
+10. Pushing changes to GitHub
+11. Verifying the successful merge
+
+This guide is designed to help users navigate the process of merging their draft content into a specific branch on GitHub, likely as part of a documentation workflow or content publishing process.
+
+  
diff --git a/dev-docs/context-docs-editor-modify a draft.md.md b/dev-docs/context-docs-editor-modify a draft.md.md
@@ -0,0 +1,14 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides step-by-step instructions on how to modify a previously published draft in a content management system or editor interface. The document outlines three main steps:
+
+1. Navigating to the "Published" section under "DRAFTS" in the sidebar and selecting the draft to modify.
+2. Loading the selected draft's content in the main editing area for review.
+3. Making modifications to the draft, which automatically saves changes and moves the draft back to the "DRAFTS" section for further editing or review before republishing.
+
+The instructions are accompanied by images to illustrate each step visually, making it easier for users to follow the process. This guide is likely part of a larger user manual or documentation for a content management or editing platform.
+
+  
diff --git a/dev-docs/context-docs-editor-rename a draft.md.md b/dev-docs/context-docs-editor-rename a draft.md.md
@@ -0,0 +1,16 @@
+
+
+  ---
+# High Level Context
+## context
+This Markdown file provides step-by-step instructions on how to rename a draft in a document editor. The content is structured as a tutorial with five steps, each accompanied by a descriptive image. The steps guide users through:
+
+1. Opening the drafts section
+2. Locating the desired draft
+3. Selecting the draft
+4. Clicking the "Rename" option
+5. Editing and saving the new draft name
+
+The file is likely part of a user guide or documentation for a document editing software or platform, helping users manage their draft documents more effectively.
+
+  
diff --git a/dev-docs/context-docs-starter-template-_category_.json.md b/dev-docs/context-docs-starter-template-_category_.json.md
@@ -0,0 +1,13 @@
+
+
+  ---
+# High Level Context
+## context
+This file is a JSON configuration for a documentation category in a documentation system, likely for a website or application. It defines properties for a category named "Starter template":
+
+1. "position": 6 - This sets the order of this category in relation to other categories, placing it sixth in the list.
+2. "label": "Starter template" - This is the display name for the category that users will see.
+
+This file is typically used in documentation frameworks (like Docusaurus) to organize and structure content, allowing for easy navigation and categorization of documentation pages.
+
+  
diff --git a/dev-docs/context-docs-starter-template-components-DevDocsAccordion.md.md b/dev-docs/context-docs-starter-template-components-DevDocsAccordion.md.md
@@ -0,0 +1,32 @@
+
+
+  ---
+# High Level Context
+## context
+This file contains documentation for a React component called Accordion. The document provides a brief description of the component, explains its usage, lists its parameters, and gives examples of how to implement it. The Accordion component is designed to create expandable and collapsible sections within a user interface, allowing for organized and compact display of content.
+
+Key points from the documentation:
+1. The component takes two main props: 'title' and 'children'
+2. It supports Markdown content within the accordion
+3. Only one accordion can be open at a time in a group
+4. The component handles its own styling and expand/collapse animations
+5. It's recommended to keep content length reasonable for optimal user experience
+
+This documentation serves as a guide for developers who want to implement the Accordion component in their React applications, providing them with the necessary information to use it effectively.
+
+---
+# Accordion docs/starter-template/components/DevDocsAccordion.md
+## Imported Code Object
+Certainly! In this code snippet, `Accordion` is a custom React component that creates an expandable/collapsible section on a webpage. Here's a concise explanation:
+
+1. `Accordion` is a container component that wraps its content.
+2. It has a `title` prop that specifies the text shown when the accordion is collapsed.
+3. The content between the opening and closing `Accordion` tags is what's displayed when expanded.
+4. It typically has two states: collapsed (showing only the title) and expanded (showing title and content).
+5. Clicking the title usually toggles between these states.
+6. It can contain any content, including markdown, lists, and code blocks.
+7. Accordions are commonly used to organize and hide/show information, saving space and improving user experience.
+
+This component allows for a clean, interactive way to present information that can be expanded or collapsed as needed.
+
+  
diff --git a/dev-docs/context-docs-starter-template-components-Tabs.md.md b/dev-docs/context-docs-starter-template-components-Tabs.md.md
@@ -0,0 +1,35 @@
+
+
+  ---
+# High Level Context
+## context
+This file provides documentation for a Tabs component in a starter template. It includes:
+
+1. A brief description of the Tabs component
+2. Parameters and props accepted by the component
+3. An example of how to use the Tabs component in JSX
+4. Notes and considerations for using the component
+
+Key points:
+- The Tabs component is built on Radix UI's Tabs primitive
+- It uses Tailwind CSS for styling
+- It's customizable through props and CSS classes
+- The component includes TabsList, TabsTrigger, and TabsContent subcomponents
+- It emphasizes accessibility and keyboard navigation
+- The documentation provides guidance on proper usage and best practices
+
+This file serves as a reference for developers using the Tabs component in their projects, offering both implementation details and usage examples.
+
+---
+# Tabs docs/starter-template/components/Tabs.md
+## Imported Code Object
+In this code snippet, `Tabs` is likely a custom React component that creates a tabbed interface. It's designed to manage and display multiple sections of content, allowing users to switch between them using tab-like controls. The `Tabs` component typically:
+
+1. Accepts a `defaultValue` prop to set the initially active tab.
+2. Contains `TabsList` for the tab buttons/triggers.
+3. Uses `TabsTrigger` components for individual tab buttons.
+4. Includes `TabsContent` components to hold the content for each tab.
+
+This structure allows for an organized and interactive way to present different pieces of information or functionality within a single container, improving user experience and interface organization.
+
+  
diff --git a/dev-docs/context-docs-starter-template-components-using-the-codesnippet-component.md.md b/dev-docs/context-docs-starter-template-components-using-the-codesnippet-component.md.md
