diff --git a/Create user-facing docs from your codebase.md b/Create user-facing docs from your codebase.md
index cc883a616..9255f2eea 100644
--- a/Create user-facing docs from your codebase.md
+++ b/Create user-facing docs from your codebase.md
@@ -1,19 +1,21 @@
-
-
- # How to Use and Customize the "Populate External Docs" Command in the VS Code Extension
+# How to Use and Customize the "Populate External Docs" Command in the VS Code Extension
## Step 1: Access the Command
1. Open your VS Code workspace
+
2. Press `Cmd+Shift+P` (Mac) or `Ctrl+Shift+P` (Windows/Linux) to open the command palette
+
3. Type "Populate External Docs" and select the command
+
## Step 2: Customizing Generation with dev-docs.json
To customize the documentation generation, modify the `dev-docs.json` file in your project root:
1. Create or open `dev-docs.json`
+
2. Add an `ai` object with customization options
Example `dev-docs.json`:
@@ -33,10 +35,13 @@ Example `dev-docs.json`:
Key customization options:
-- `internalTypeFilters`: Specify which code elements to document
-- `docSubFolder`: Set the output folder for generated docs
-- `merge`: Combine multiple elements into a single document
-- `externalDocPrompt`: Customize the AI prompt for doc generation
+* `internalTypeFilters`: Specify which code elements to document
+
+* `docSubFolder`: Set the output folder for generated docs
+
+* `merge`: Combine multiple elements into a single document
+
+* `externalDocPrompt`: Customize the AI prompt for doc generation
The `generateBySymbols` function in `src/AiServices.ts` uses these settings to generate documentation.
@@ -45,9 +50,9 @@ The `generateBySymbols` function in `src/AiServices.ts` uses these settings to g
After running the command:
1. Check the `docs` folder (or your specified `docSubFolder`) for generated files
+
2. Review and edit the generated content as needed
+
3. Commit changes to your repository
By following these steps and customizing the `dev-docs.json`, you can efficiently generate and manage external documentation for your project using the VS Code extension.
-
-
\ No newline at end of file
diff --git a/docs/ci-cd-integration.md b/docs/ci-cd-integration.md
new file mode 100644
index 000000000..f571e9967
--- /dev/null
+++ b/docs/ci-cd-integration.md
@@ -0,0 +1,65 @@
+# Integrating Dev-Docs with CI/CD Pipelines
+
+Dev-Docs can be seamlessly integrated into your CI/CD pipelines to automate documentation generation and updates. This guide will walk you through the process of setting up Dev-Docs in your CI/CD workflow.
+
+## Prerequisites
+
+* A GitHub repository with Dev-Docs installed
+
+* A CI/CD platform (e.g. GitHub Actions, Jenkins, GitLab CI)
+
+## Step 1: Configure dev-docs.json
+
+Ensure your `dev-docs.json` file is properly configured to enable automated workflows:
+
+```json
+{
+ "gitHubApp": {
+ "workflows": ["generateDocs", "generateChangelog"]
+ }
+}
+```
+
+## Step 2: Set up CI/CD job
+
+Add a new job to your CI/CD configuration that triggers Dev-Docs documentation generation. Here's an example using GitHub Actions:
+
+```yaml
+name: Generate Docs
+on:
+ push:
+ branches: [main]
+ paths:
+ - '**.js'
+
+jobs:
+ dev-docs-app:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Generate Docs
+ run: |
+ curl -X POST ${{ secrets.GENERATE_ENDPOINT_URL }} \
+ -H "Content-Type: application/json" \
+ -d '{
+ "timestamp": "${{ github.event.head_commit.timestamp }}",
+ "apiKey": "${{ secrets.DEV_DOCS_API_KEY }}",
+ "githubToken": "${{ secrets.GITHUB_TOKEN }}",
+ "repo": "${{ github.repository }}",
+ "actor": "${{ github.actor }}"
+ }'
+```
+
+## Step 3: Add necessary secrets
+
+In your repository or CI/CD platform settings, add the following secrets:
+
+* `DEV_DOCS_API_KEY`: Your Dev-Docs API key
+
+* `GENERATE_ENDPOINT_URL`: The URL for the Dev-Docs generation service
+
+## Step 4: Commit and push
+
+Commit the changes to your CI/CD configuration and push to your repository. The documentation generation will now run automatically on every push to the main branch that includes changes to JavaScript files.
+
+By integrating Dev-Docs with your CI/CD pipeline, you ensure that your documentation stays up-to-date with your codebase, improving collaboration and reducing manual documentation efforts.
diff --git a/docs/documentation-workflow.md b/docs/documentation-workflow.md
new file mode 100644
index 000000000..28828be09
--- /dev/null
+++ b/docs/documentation-workflow.md
@@ -0,0 +1,61 @@
+# Documentation Workflow Guide
+
+Effective documentation is crucial for project success. This guide outlines best practices for integrating documentation into your project workflow.
+
+## 1. Set Up Your Documentation Infrastructure
+
+* Choose a documentation tool or platform (e.g. Markdown files in version control, wiki, etc.)
+
+* Create a dedicated docs folder in your project repository
+
+* Set up any necessary build processes for generating docs
+
+## 2. Integrate Documentation into Development Process
+
+* Make documentation updates part of your Definition of Done for tasks
+
+* Include documentation review in your code review process
+
+* Set up automated checks to ensure docs are updated with code changes
+
+## 3. Leverage AI-Assisted Documentation
+
+* Use tools like Dev-Docs to generate initial documentation from your codebase
+
+* Leverage AI to keep docs up-to-date as code changes
+
+* Use AI-powered auditing to identify gaps or inconsistencies in docs
+
+## 4. Establish Documentation Standards
+
+* Create templates for common doc types (API references, tutorials, etc.)
+
+* Define style guides for consistency across docs
+
+* Set up linting to enforce doc standards
+
+## 5. Implement Documentation Reviews
+
+* Include technical writers or doc specialists in review process
+
+* Set up dedicated documentation review meetings
+
+* Use checklists to ensure key elements are covered
+
+## 6. Version and Release Documentation
+
+* Tie documentation versions to software releases
+
+* Set up workflows to publish docs with each release
+
+* Maintain changelogs to track doc updates
+
+## 7. Gather Feedback and Iterate
+
+* Set up mechanisms to collect user feedback on docs
+
+* Regularly review and refine documentation based on feedback
+
+* Track documentation-related metrics to measure effectiveness
+
+By following these steps, you can create a robust documentation workflow that keeps your project docs accurate, up-to-date, and valuable for users.
diff --git a/docs/introduction-to-dev-docs.md b/docs/introduction-to-dev-docs.md
index f84a34560..52a29f60d 100644
--- a/docs/introduction-to-dev-docs.md
+++ b/docs/introduction-to-dev-docs.md
@@ -4,28 +4,23 @@ title: "Welcome"
sidebar_position: 1
---
- # Welcome to Dev-Docs
-Dev-Docs is a powerful documentation solution that streamlines the process of creating, managing, and maintaining high-quality documentation for your codebase. Using AI-powered analysis and Markdown formatting, Dev-Docs ensures that your documentation is always up-to-date, comprehensive, and easily accessible. Use Dev-Docs to document your codebase, APIs, and SDKs, as well as new features and use cases of your product.
-## Why Choose Dev-Docs?
-
-- **Seamless Integration**: Integrate Dev-Docs directly into your development workflow with our VS Code extension and into your CI/CD with our GitHub App. Generate Markdown files and manage your docs without ever leaving your familiar environment. Push the docs to where your teams or users are already reading them.
-
-
+# Welcome to Dev-Docs
-- **Customizable Output**: Tailor the AI-generated content to your specific needs with customizable prompts and filters. Dev-Docs adapts to your project's unique requirements, ensuring that the generated documentation aligns perfectly with your standards. Edit the final output as you see fit. The final say is always yours!
+Dev-Docs is a powerful documentation solution that streamlines the process of creating, managing, and maintaining high-quality documentation for your codebase. Using AI-powered analysis and Markdown formatting, Dev-Docs ensures that your documentation is always up-to-date, comprehensive, and easily accessible. Use Dev-Docs to document your codebase, APIs, and SDKs, as well as new features and use cases of your product.
-
+## Why Choose Dev-Docs?
-- **Improved SEO and Developer Experience**: Well-documented projects are more discoverable and attractive to potential users and customers. Dev-Docs helps you create comprehensive, SEO-friendly documentation that can boost your project's visibility, enable faster customer onboarding and drive sales.
+* **Seamless Integration**: Integrate Dev-Docs directly into your development workflow with our VS Code extension and into your CI/CD with our GitHub App. Generate Markdown files and manage your docs without ever leaving your familiar environment. Push the docs to where your teams or users are already reading them.
-
+* **Customizable Output**: Tailor the AI-generated content to your specific needs with customizable prompts and filters. Dev-Docs adapts to your project's unique requirements, ensuring that the generated documentation aligns perfectly with your standards. Edit the final output as you see fit. The final say is always yours!
-- **Time and Cost Savings**: By automating much of the documentation process, Dev-Docs helps your team save valuable time and resources, allowing them to focus on core development and documentation tasks while maintaining high-quality content for your docs.
+* **Improved SEO and Developer Experience**: Well-documented projects are more discoverable and attractive to potential users and customers. Dev-Docs helps you create comprehensive, SEO-friendly documentation that can boost your project's visibility, enable faster customer onboarding and drive sales.
+* **Time and Cost Savings**: By automating much of the documentation process, Dev-Docs helps your team save valuable time and resources, allowing them to focus on core development and documentation tasks while maintaining high-quality content for your docs.
-## Primary Use Cases
+## How it Works:
### Internal Team Documentation
@@ -33,17 +28,12 @@ Dev-Docs excels at generating and maintaining documentation for your internal de
### User-Facing Documentation
-Dev-Docs helps you create clear, concise, and user-friendly documentation. From API guides to SDK references, Dev-Docs ensures that your user-facing documentation is always in sync with your latest code changes, improving the overall developer experience for your users. Bridge the gap between your teams managing the docs and your devs shipping code with Dev-Docs.
+Dev-Docs helps you create clear, concise, and user-friendly documentation. From API guides to SDK references, Dev-Docs ensures that your user-facing documentation is always in sync with your latest code changes, improving the overall developer experience for your users. Bridge the gap between your teams managing the docs and your devs shipping code with Dev-Docs.
## Getting Started
Whether you're working on a small project or managing a large-scale application, Dev-Docs has the tools and features to elevate your documentation process. Explore our guides and tutorials to learn how Dev-Docs can revolutionize your approach to documentation and enhance your overall development experience.
-
-
-[Get Started Now](docs/Dev-Docs-Quickstart)
-
-
+Get Started Now
Empower your team, enhance your documentation, and accelerate your product's success with Dev-Docs – the future of developer documentation.
-
diff --git a/docs/ollama-revolutionizing-local-llms.md b/docs/ollama-revolutionizing-local-llms.md
new file mode 100644
index 000000000..a1b4fe932
--- /dev/null
+++ b/docs/ollama-revolutionizing-local-llms.md
@@ -0,0 +1,90 @@
+
+
+ # Ollama: Revolutionizing Local LLMs
+
+In the rapidly evolving landscape of artificial intelligence, Ollama stands out as a game-changer for local large language models (LLMs). As the demand for privacy-conscious and efficient AI solutions grows, Ollama emerges as the future of local LLMs, offering a powerful and flexible platform for developers and enthusiasts alike.
+
+## Why Ollama is the Future
+
+1. **Local Processing**: Ollama allows you to run LLMs directly on your machine, ensuring data privacy and reducing latency.
+
+2. **Ease of Use**: With a simple CLI and API, Ollama makes it incredibly easy to deploy and interact with state-of-the-art language models.
+
+3. **Customization**: Ollama supports model fine-tuning and creation of custom models, giving users unprecedented control over their AI capabilities.
+
+4. **Performance**: Optimized for various hardware configurations, Ollama delivers impressive performance even on consumer-grade machines.
+
+5. **Open Source**: The open-source nature of Ollama fosters innovation and community-driven improvements.
+
+## Spotlight on SDK Features
+
+Ollama's JavaScript SDK offers a rich set of features that make integrating LLMs into your applications a breeze:
+
+### 1. Streamable Responses
+
+The SDK supports streamable responses, allowing for real-time generation of content:
+
+```javascript
+const response = await ollama.generate({
+ model: 'llama2',
+ prompt: 'Tell me a story',
+ stream: true
+});
+
+for await (const part of response) {
+ console.log(part.response);
+}
+```
+
+### 2. Multi-Modal Capabilities
+
+Ollama supports multi-modal inputs, including images:
+
+```javascript
+const response = await ollama.generate({
+ model: 'llava',
+ prompt: 'Describe this image',
+ images: [imageBuffer]
+});
+```
+
+### 3. Model Management
+
+Easily manage your models with built-in functions:
+
+```javascript
+await ollama.pull({ model: 'llama2' });
+await ollama.push({ model: 'my-custom-model' });
+await ollama.create({
+ model: 'my-new-model',
+ path: './my-modelfile'
+});
+```
+
+### 4. Embeddings Generation
+
+Generate embeddings for text analysis and similarity searches:
+
+```javascript
+const response = await ollama.embeddings({
+ model: 'llama2',
+ prompt: 'Understand the context'
+});
+```
+
+### 5. Flexible Configuration
+
+Customize your Ollama instance with various options:
+
+```javascript
+const customOllama = new Ollama({
+ host: 'http://localhost:11434',
+ headers: { 'Custom-Header': 'Value' }
+});
+```
+
+## Conclusion
+
+Ollama represents the future of local LLMs by combining ease of use, powerful features, and flexibility. Whether you're a developer looking to integrate AI capabilities into your applications or an AI enthusiast exploring the potential of language models, Ollama provides the tools and performance you need. As the AI landscape continues to evolve, Ollama stands ready to empower users with cutting-edge language models right at their fingertips.
+
+
\ No newline at end of file
diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md
new file mode 100644
index 000000000..804c8fa6c
--- /dev/null
+++ b/docs/quick-start-guide.md
@@ -0,0 +1,41 @@
+# Dev-Docs Quick Start Guide
+
+This guide will help you get started with Dev-Docs quickly.
+
+## Installation
+
+1. Install the Dev-Docs VS Code extension from the marketplace.
+2. Sign in to Dev-Docs in VS Code.
+
+## Generating Documentation
+
+1. Open a code file you want to document.
+2. Press Shift+Cmd+D (Mac) or Shift+Ctrl+D (Windows/Linux) to generate documentation.
+3. Review and edit the generated docs as needed.
+
+## Customizing Generation
+
+1. Create a `dev-docs.json` file in your project root.
+2. Add customization options like:
+
+```json
+{
+ "ai": {
+ "internalTypeFilters": ["class", "method", "function"],
+ "contextPrompt": "Generate comprehensive API documentation"
+ }
+}
+```
+
+3. Adjust options to fit your project's needs.
+
+## Using the Web Editor
+
+1. Go to the Dev-Docs web app.
+2. Use the rich text editor to create and edit markdown docs.
+3. Add images, tables, and other elements easily.
+
+## Next Steps
+
+- Explore more features like auditing docs and generating OpenAPI specs.
+- Check out the full documentation for advanced usage.
\ No newline at end of file
diff --git a/docs/removeBackgroundColor.md b/docs/removeBackgroundColor.md
new file mode 100644
index 000000000..ef301910e
--- /dev/null
+++ b/docs/removeBackgroundColor.md
@@ -0,0 +1,40 @@
+# removeBackgroundColor Documentation
+
+## Brief Description
+The `removeBackgroundColor` function removes a specified color from an image, making it transparent.
+
+## Usage
+To use `removeBackgroundColor`, you need to import it from the appropriate module and call it with the required parameters.
+
+```javascript
+import { removeBackgroundColor } from './path/to/module';
+```
+
+## Parameters
+- `inputPath` (string, required): The file path of the input image.
+- `outputPath` (string, required): The file path where the processed image will be saved.
+- `targetColor` (string, required): The color to be removed, specified as a CSS color string (e.g., '#FFFFFF' for white).
+- `colorThreshold` (number, optional): The tolerance for color matching. Default is 0.
+- `options` (object, optional): Additional options for image processing. Default is an empty object.
+
+## Return Value
+The function returns a Promise that resolves with the result of the image processing operation.
+
+## Examples
+
+### Basic Usage
+```javascript
+await removeBackgroundColor('input.png', 'output.png', '#FFFFFF');
+```
+
+### With Color Threshold
+```javascript
+await removeBackgroundColor('input.png', 'output.png', '#FF0000', 10);
+```
+
+## Notes or Considerations
+- The function uses the Jimp library for image processing.
+- The color matching is based on the `Jimp.colorDiff` method, which calculates the difference between colors.
+- Large color thresholds may result in unintended transparency in areas with similar colors.
+- Ensure that the input file exists and the output path is writable.
+- The function works best with images that have a distinct background color.
\ No newline at end of file
diff --git a/docs/rotateSpritesheet.md b/docs/rotateSpritesheet.md
new file mode 100644
index 000000000..1399892ec
--- /dev/null
+++ b/docs/rotateSpritesheet.md
@@ -0,0 +1,52 @@
+# rotateSpritesheet Documentation
+
+## Brief Description
+
+`rotateSpritesheet` is an asynchronous function tgdfgfdgfdgdfghat rotates a spritesheet image by a specified number of degrees.
+
+## Usage
+
+To use `rotateSpritesheet`, you need to import it from the module where it's defined. It takes an image buffer and a rotation angle as input.
+
+```javascript
+import { rotateSpritesheet } from './path/to/module';
+```
+
+## Parameters
+
+* `inputBuffer` (Buffer): The input image buffer containing the spritesheet.
+
+* `degrees` (Number): The number of degrees to rotate the spritesheet.
+
+## Return Value
+
+Returns a Promise that resolves to a Buffer containing the rotated spritesheet image.
+
+## Examples
+
+Basic usage:
+
+```javascript
+const fs = require('fs').promises;
+const rotatedBuffer = await rotateSpritesheet(await fs.readFile('input.png'), 90);
+await fs.writeFile('rotated.png', rotatedBuffer);
+```
+
+Using with the sprite object:
+
+```javascript
+const sprite = await sprite.generateSprite('character');
+const rotatedSprite = await rotateSpritesheet(Buffer.from(sprite.image.split(',')[1], 'base64'), 45);
+```
+
+## Notes or Considerations
+
+* The function uses the Sharp library internally for image processing.
+
+* Rotation is performed around the center of the image.
+
+* Non-rectangular spritesheets may have parts cropped off after rotation.
+
+* Large spritesheets may require more processing time and memory.
+
+* Consider the impact on frame alignment when rotating animation spritesheets.
diff --git a/docs/security-best-practices.md b/docs/security-best-practices.md
new file mode 100644
index 000000000..57752a551
--- /dev/null
+++ b/docs/security-best-practices.md
@@ -0,0 +1,31 @@
+# Security Best Practices for Documentation Management
+
+## Access Control
+- Implement strong authentication mechanisms (e.g. multi-factor authentication) for accessing documentation systems
+- Use role-based access control to restrict access to sensitive documents
+- Regularly audit and review user access permissions
+
+## Data Protection
+- Encrypt sensitive documentation, both in transit and at rest
+- Back up documentation regularly and store backups securely
+- Implement data loss prevention tools to prevent unauthorized sharing of sensitive docs
+
+## Secure Development
+- Follow secure coding practices when developing documentation tools/platforms
+- Perform regular security testing and vulnerability scans
+- Keep all software and dependencies up-to-date with security patches
+
+## Monitoring and Incident Response
+- Implement logging and monitoring to detect suspicious activities
+- Develop and maintain an incident response plan for documentation-related security incidents
+- Conduct regular security awareness training for all users of the documentation system
+
+## Compliance
+- Ensure documentation practices comply with relevant regulations (e.g. GDPR, HIPAA)
+- Implement appropriate data retention and deletion policies
+- Maintain an audit trail of all access and changes to sensitive documents
+
+## Third-Party Risk Management
+- Evaluate the security practices of any third-party documentation tools or services
+- Implement appropriate controls when sharing documentation with external parties
+- Regularly review third-party access and revoke when no longer needed
\ No newline at end of file
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
new file mode 100644
index 000000000..45f7d0ec7
--- /dev/null
+++ b/docs/troubleshooting.md
@@ -0,0 +1,81 @@
+# Troubleshooting
+
+This guide covers common issues you may encounter when using Dev-Docs and how to resolve them.
+
+## VS Code Extension Issues
+
+### Extension Not Working
+
+If the Dev-Docs extension is not functioning in VS Code:
+
+1. Ensure you are signed in to your Dev-Docs account in the extension
+
+2. Check that you have an active internet connection
+
+3. Try reloading the VS Code window (Ctrl+R or Cmd+R)
+
+4. Uninstall and reinstall the extension if issues persist
+
+### Cannot Generate Documentation
+
+If you're unable to generate documentation using the extension:
+
+1. Verify you have the necessary permissions in your Dev-Docs account
+
+2. Check your `dev-docs.json` configuration file for errors
+
+3. Ensure the files you're trying to document are saved and not in a pending state
+
+## Web App Issues
+
+### Cannot Access Web Editor
+
+If you're unable to access the web editor:
+
+1. Clear your browser cache and cookies
+
+2. Try accessing from an incognito/private browsing window
+
+3. Verify your account has the necessary permissions
+
+### Changes Not Saving
+
+If changes in the web editor are not saving:
+
+1. Check your internet connection
+
+2. Ensure you're not in read-only mode
+
+3. Try refreshing the page and making changes again
+
+## GitHub App Integration Issues
+
+### Workflows Not Running
+
+If automated workflows are not running:
+
+1. Check your `dev-docs.json` file for correct workflow configuration
+
+2. Ensure the GitHub App has necessary permissions on your repository
+
+3. Verify that your repository meets any conditions specified for workflow triggers
+
+### API Key Issues
+
+If you're encountering API key related errors:
+
+1. Regenerate your API key in the Dev-Docs dashboard
+
+2. Ensure the API key is correctly set in your GitHub repository secrets
+
+3. Check that the API key has the necessary permissions
+
+## General Troubleshooting Steps
+
+1. Check the Dev-Docs status page for any ongoing service issues
+
+2. Review your account's usage limits and upgrade if necessary
+
+3. Contact Dev-Docs support if issues persist after trying these steps
+
+Remember to keep your Dev-Docs extension, web app, and GitHub App integrations up to date for the best experience and latest features.
diff --git a/undefined b/undefined
new file mode 100644
index 000000000..e69de29bb