From b7896a24d25e94f6a9468ed1088d7bba6e305acf Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 00:09:25 +0000 Subject: [PATCH 1/4] md file --- ...ditor-comprehensive-functionality-guide.md | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 docs/dev-docs-web-editor-comprehensive-functionality-guide.md diff --git a/docs/dev-docs-web-editor-comprehensive-functionality-guide.md b/docs/dev-docs-web-editor-comprehensive-functionality-guide.md new file mode 100644 index 000000000..a9aa8a500 --- /dev/null +++ b/docs/dev-docs-web-editor-comprehensive-functionality-guide.md @@ -0,0 +1,71 @@ + + + # Dev-Docs Web Editor: Comprehensive Functionality Guide + +The Dev-Docs web editor is a powerful tool designed to streamline documentation creation, editing, and management. This guide outlines the various capabilities of the editor, highlighting its key features and integration with GitHub. + +## Content Creation and Editing + +### Rich Text and Markdown Editing +- Switch between rich text and raw markdown views for flexible content creation +- Edit and format content using markdown syntax or rich text tools + +### Draft Management +- Create, rename, modify, and delete drafts +- Automatically save changes to prevent work loss + +### AI-Assisted Content Generation +- Generate content based on existing documentation or codebase +- Use AI helpers for various editing tasks: + - Adjust text length + - Change content tone + - Edit selected portions + - Fix spelling and grammar + +### Visual Elements +- Add and edit images within documents +- Insert and format tables to organize information + +### Frontmatter Editing +- Add and edit frontmatter for managing document metadata + +## Version Control and Collaboration + +### Branch Management +- Create new branches for different versions or features +- Merge drafts to specific branches on GitHub + +### GitHub Integration +- Connect GitHub repositories to access codebase and existing documentation +- Push edited content directly to GitHub repositories +- Set up automated workflows for internal documentation and changelog generation + +## Documentation Organization + +### File Structure Management +- Generate and manage `llm.txt` files for organizing static content +- Create and maintain a structured documentation hierarchy + +## Auditing and Quality Control + +### Content Auditing +- Use AI-powered tools to audit existing documentation +- Identify inconsistencies and areas for improvement + +### SEO and Sales Support +- Improve documentation quality to enhance SEO efforts +- Create comprehensive guides to support sales initiatives + +## Advanced Features + +### Codebase-Driven Documentation +- Generate documentation content by analyzing connected GitHub repositories +- Create starter templates for quick documentation setup + +### Customization +- Tailor the editor's functionality to specific project needs +- Integrate with existing development workflows + +By leveraging these features, the Dev-Docs web editor provides a comprehensive solution for managing documentation alongside code development, catering to both technical and non-technical users involved in the documentation process. + + \ No newline at end of file From 864bf4d3b83a4dd4025c01b62a46aef2e04aa053 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 00:09:53 +0000 Subject: [PATCH 2/4] Update file --- ...ditor-comprehensive-functionality-guide.md | 90 ++++++++++++------- 1 file changed, 57 insertions(+), 33 deletions(-) diff --git a/docs/dev-docs-web-editor-comprehensive-functionality-guide.md b/docs/dev-docs-web-editor-comprehensive-functionality-guide.md index a9aa8a500..32b0a9458 100644 --- a/docs/dev-docs-web-editor-comprehensive-functionality-guide.md +++ b/docs/dev-docs-web-editor-comprehensive-functionality-guide.md @@ -1,71 +1,95 @@ - - - # Dev-Docs Web Editor: Comprehensive Functionality Guide +# Dev-Docs Web Editor: Comprehensive Functionality Guide test The Dev-Docs web editor is a powerful tool designed to streamline documentation creation, editing, and management. This guide outlines the various capabilities of the editor, highlighting its key features and integration with GitHub. ## Content Creation and Editing ### Rich Text and Markdown Editing -- Switch between rich text and raw markdown views for flexible content creation -- Edit and format content using markdown syntax or rich text tools + +* Switch between rich text and raw markdown views for flexible content creation + +* Edit and format content using markdown syntax or rich text tools ### Draft Management -- Create, rename, modify, and delete drafts -- Automatically save changes to prevent work loss + +* Create, rename, modify, and delete drafts + +* Automatically save changes to prevent work loss ### AI-Assisted Content Generation -- Generate content based on existing documentation or codebase -- Use AI helpers for various editing tasks: - - Adjust text length - - Change content tone - - Edit selected portions - - Fix spelling and grammar + +* Generate content based on existing documentation or codebase + +* Use AI helpers for various editing tasks: + + * Adjust text length + + * Change content tone + + * Edit selected portions + + * Fix spelling and grammar ### Visual Elements -- Add and edit images within documents -- Insert and format tables to organize information + +* Add and edit images within documents + +* Insert and format tables to organize information ### Frontmatter Editing -- Add and edit frontmatter for managing document metadata + +* Add and edit frontmatter for managing document metadata ## Version Control and Collaboration ### Branch Management -- Create new branches for different versions or features -- Merge drafts to specific branches on GitHub + +* Create new branches for different versions or features + +* Merge drafts to specific branches on GitHub ### GitHub Integration -- Connect GitHub repositories to access codebase and existing documentation -- Push edited content directly to GitHub repositories -- Set up automated workflows for internal documentation and changelog generation + +* Connect GitHub repositories to access codebase and existing documentation + +* Push edited content directly to GitHub repositories + +* Set up automated workflows for internal documentation and changelog generation ## Documentation Organization ### File Structure Management -- Generate and manage `llm.txt` files for organizing static content -- Create and maintain a structured documentation hierarchy + +* Generate and manage `llm.txt` files for organizing static content + +* Create and maintain a structured documentation hierarchy ## Auditing and Quality Control ### Content Auditing -- Use AI-powered tools to audit existing documentation -- Identify inconsistencies and areas for improvement + +* Use AI-powered tools to audit existing documentation + +* Identify inconsistencies and areas for improvement ### SEO and Sales Support -- Improve documentation quality to enhance SEO efforts -- Create comprehensive guides to support sales initiatives + +* Improve documentation quality to enhance SEO efforts + +* Create comprehensive guides to support sales initiatives ## Advanced Features ### Codebase-Driven Documentation -- Generate documentation content by analyzing connected GitHub repositories -- Create starter templates for quick documentation setup + +* Generate documentation content by analyzing connected GitHub repositories + +* Create starter templates for quick documentation setup ### Customization -- Tailor the editor's functionality to specific project needs -- Integrate with existing development workflows -By leveraging these features, the Dev-Docs web editor provides a comprehensive solution for managing documentation alongside code development, catering to both technical and non-technical users involved in the documentation process. +* Tailor the editor's functionality to specific project needs + +* Integrate with existing development workflows - \ No newline at end of file +By leveraging these features, the Dev-Docs web editor provides a comprehensive solution for managing documentation alongside code development, catering to both technical and non-technical users involved in the documentation process. From 7fed505c59c0c80a679147f8e9be3e7d58e050ec Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 00:12:00 +0000 Subject: [PATCH 3/4] md file --- ...dev-docs-web-editor-comprehensive-guide.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/dev-docs-web-editor-comprehensive-guide.md diff --git a/docs/dev-docs-web-editor-comprehensive-guide.md b/docs/dev-docs-web-editor-comprehensive-guide.md new file mode 100644 index 000000000..dac36086e --- /dev/null +++ b/docs/dev-docs-web-editor-comprehensive-guide.md @@ -0,0 +1,41 @@ + + + # Dev-Docs Web Editor: A Comprehensive Guide + +- **Web Editor Overview**: A powerful tool for creating, editing, and managing documentation with features like rich text and raw markdown editing, draft management, AI-assisted content generation, image and table insertion, frontmatter editing, and automatic saving. It also offers seamless GitHub integration for repository connection, branch management, automated workflows, and content generation from codebase. + +- **Add an Image**: Easily insert images into your documentation by selecting the image location, accessing formatting options, choosing "Add Image" from the menu, specifying the folder location, naming the image, and uploading it. + +- **Add and Edit Frontmatter**: Manage metadata for your documents by opening the metadata drawer, adding new parameters and values, and saving the changes to enhance document organization and categorization. + +- **Audit Your Docs**: Improve document quality by navigating to the audit feature, selecting documents for audit, providing an audit topic, reviewing results, and making necessary changes to drafts. + +- **Connect the Starter Template to the AI Editor**: Set up your documentation project by generating starter template docs, creating a new GitHub repository, and connecting it to the Dev-Docs AI editor. + +- **Generate Content from Existing Content**: Streamline content creation by selecting specific documents as context, specifying your task for the AI, and refining the generated content. + +- **Generate Content from Your Codebase**: Enhance documentation by authorizing the Dev-Docs GitHub App, selecting repositories, and using the content generation interface to create documentation based on your codebase. + +- **View Raw Markdown**: Switch between rich text and raw markdown views to have precise control over formatting and structure. + +- **Add a New Draft**: Create new drafts by navigating to the Drafts section, initiating a new draft, and composing your content in the main editor area. + +- **Connect Existing Docs Repo to Editor**: Integrate your existing documentation repository by installing the GitHub App, selecting your repository, and setting it up in the Dev-Docs editor. + +- **Create a New Branch**: Manage different versions of your documentation by accessing the branch menu, creating a new branch, and verifying its creation. + +- **Delete a Draft**: Remove unwanted drafts by navigating to the Drafts section, selecting the draft to delete, and confirming the deletion. + +- **Generate a llm.txt File**: Create or update a llm.txt file by specifying the file location and generating it through the Dev-Docs interface. + +- **Merge Your Drafts to Another Branch**: Push your draft changes to GitHub by selecting drafts to merge, choosing the target branch, and initiating the merge process. + +- **Modify a Draft**: Edit published drafts by navigating to the Published section, loading the draft content, making modifications, and preparing it for republishing. + +- **Rename a Draft**: Easily change draft names by locating the draft, selecting the rename option, editing the name, and confirming the change. + +- **Use AI Helpers in the Editor**: Enhance your writing with AI-powered tools by selecting text, accessing AI tools from the toolbar, choosing editing actions, and refining the AI-generated content. + +This comprehensive guide showcases the powerful features and workflows available in the Dev-Docs web editor, enabling efficient documentation management, collaboration, and integration with development processes. + + \ No newline at end of file From 2dc8a064ef225b3f409a1d422699320742f1ff0c Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Wed, 19 Feb 2025 00:15:20 +0000 Subject: [PATCH 4/4] md file --- docs/web-editor-guide.md | 163 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 docs/web-editor-guide.md diff --git a/docs/web-editor-guide.md b/docs/web-editor-guide.md new file mode 100644 index 000000000..6814279e3 --- /dev/null +++ b/docs/web-editor-guide.md @@ -0,0 +1,163 @@ + + + # Web Editor Guide + +## Overview + +The Dev-Docs web editor is a powerful tool designed to streamline the process of creating, editing, and managing documentation. It offers a range of features that enhance the documentation workflow, particularly in conjunction with GitHub integration. + +### Key Features + +1. Rich Text and Raw Markdown Editing +2. Draft Management +3. AI-Assisted Content Generation +4. Image and Table Insertion +5. Frontmatter Editing +6. Automatic Saving + +### GitHub Integration + +- Repository Connection +- Branch Management +- Automated Workflows +- Push to GitHub +- Content Generation from Codebase + +## Basic Operations + +### Add an Image + +1. Position your cursor where you want to add the image. +2. Click on the "+" icon to open the formatting options menu. +3. Select the "Add Image" option. +4. In the image upload dialog, specify the folder location and image name. +5. Click "Add Image" and choose the image file from your computer. +6. The image will be uploaded and displayed in your document. + +### Add and Edit Frontmatter + +1. Click the info button to open the metadata drawer. +2. In the "File metadata" section, click in the "Parameter" field to add a new parameter. +3. Enter the parameter name and value. +4. Click "Add" to add the parameter to the frontmatter. +5. Repeat for additional parameters. +6. Click "Save Changes" to save the added frontmatter. + +### View Raw Markdown Content + +1. Open your document in the rich text editor mode. +2. Locate the "Rich text editor" dropdown menu in the top right corner. +3. Click on the dropdown menu and select "Raw editor". +4. The view will switch to display the raw markdown content of your document. +5. To switch back, use the same dropdown menu and select "Rich text editor". + +### Add a New Draft + +1. Navigate to the "DRAFTS" section in the left sidebar. +2. Click on the "New Draft" button. +3. Enter your draft name and press "enter". +4. Start typing your content in the main editor area. + +### Create a New Branch + +1. Access the branch menu in the left sidebar. +2. Click on the "+ New branch" button. +3. Enter the desired name for the new branch. +4. Select the base branch and click "Add Branch". +5. You'll be automatically switched to your newly created branch. + +### Delete a Draft + +1. Open the "DRAFTS" section in the left sidebar. +2. Hover over the draft you want to delete. +3. Click on the "Delete" button (trash can icon). +4. Confirm the deletion in the dialog that appears. + +### Generate a llm.txt File + +1. Open the "Create/Update LLM.txt" dialog box. +2. In the "File Location" field, specify where you want the llm.txt file to be created. +3. Click the "Generate" button. +4. Verify that the file has been created in the specified location. + +### Merge Your Drafts to Another Branch + +1. Click the "Push to GitHub" button in the top right corner. +2. Select the drafts you want to merge. +3. Choose the target branch for merging. +4. Click "Push change to GitHub" to start the merging process. +5. Confirm the successful merge and review changes on GitHub. + +### Modify a Draft + +1. Navigate to the "Published" section under "DRAFTS" in the left sidebar. +2. Select the published draft you want to modify. +3. Make your desired modifications. +4. Review and finalize your changes. +5. Prepare for republishing by pushing changes for review. + +### Rename a Draft + +1. Open the drafts section in the document editor. +2. Locate and select the draft you want to rename. +3. Click the "Rename" option next to the draft. +4. Edit the name of the draft in the text field that appears. +5. Click outside the text field or press Enter to save the new name. + +### Use AI Helpers in the Editor + +1. Open your document in the editor. +2. Select the text you want to modify. +3. Click on the "AI tools" option in the toolbar. +4. Choose an AI-powered editing action from the dropdown menu. +5. Wait for AI processing to complete. +6. Review and refine the AI-generated content. +7. Iterate and refine as needed. + +## Advanced Features + +### Audit Your Docs + +1. Click on "Audit your docs" in the top bar. +2. Select documents for audit and provide audit criteria. +3. Review identified issues and select ones to address. +4. Copy affected pages to drafts for modification. +5. Make necessary changes to drafts. + +### Connect the Starter Template to the AI Editor + +1. Navigate to the Dev-Docs dashboard and click "User-facing docs". +2. Generate starter template docs. +3. Create a new repository on GitHub using the template. +4. Set up the repository details and create the repository. +5. Return to Dev-Docs to connect your new docs. +6. Follow the prompts to set up and connect your documentation repository. + +### Generate Content from Existing Content + +1. Click "Generate Content" to open the generate content UI. +2. Choose specific documents or folders to use as context. +3. Specify your task for Dev-Docs AI. +4. Provide a prompt and submit. +5. Review, edit, and refine the generated content. + +### Generate Content from Your Codebase and Docs + +1. Authorize the Dev-Docs GitHub App. +2. Install the Dev-Docs GitHub App on your account or organization. +3. Configure repository access. +4. Access the content generation interface in Dev-Docs. +5. Choose the context for content generation. +6. Review, refine, and finalize the generated content. + +### Connect Existing Docs Repo to Editor + +1. Click "Connect your own docs" in Dev-Docs. +2. Install the GitHub App and select your repository. +3. Associate your repository with your Dev-Docs organization. +4. Set your documentation repository in Dev-Docs. +5. Access the AI editor for your docs and start editing. + +By mastering these features, you can efficiently create, manage, and improve your documentation using the Dev-Docs web editor. + + \ No newline at end of file