Dev-Docs Update

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
 
+![](upload)
 
 ## 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.
-
-

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.

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.

docs/introduction-to-dev-docs.md

@@ -4,46 +4,36 @@ 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.
-
-<br></br>
+# 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.
 
-<br></br>
+## 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.
 
-<br></br>
+* **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
 
 Dev-Docs excels at generating and maintaining documentation for your internal development teams. It helps create comprehensive guides, API references, and codebase overviews, ensuring that your team members have access to up-to-date information about your project's architecture, functionality, and best practices.
 
 ### 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.
 
-<br></br>
-
-[Get Started Now](docs/Dev-Docs-Quickstart)
-
-<br></br>
+Get Started Now
 
 Empower your team, enhance your documentation, and accelerate your product's success with Dev-Docs – the future of developer documentation.
-

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.
+
+

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.