@crownpeak/dqm-react-component-dev-mcp 1.2.0

package/data/probe/site/contributing/documentation-maintenance.md

@@ -0,0 +1,275 @@
+# Probe Documentation Maintenance Guide
+
+This guide is for documentation maintainers and contributors. It provides technical information about the documentation structure, cross-references, and navigation configuration.
+
+## Navigation Structure
+
+The Probe documentation uses VitePress and follows a specific navigation structure designed to provide a logical organization of content.
+
+### VitePress Configuration
+
+Add this configuration to your VitePress configuration file (`.vitepress/config.js`):
+
+```javascript
+export default {
+  // ... other VitePress configuration options
+  
+  themeConfig: {
+    // ... other theme configuration options
+    
+    sidebar: {
+      '/': [
+        {
+          text: 'Getting Started',
+          collapsed: false,
+          items: [
+            { text: 'Quick Start', link: '/quick-start' },
+            { text: 'Installation', link: '/installation' },
+            { text: 'Core Features', link: '/features' },
+          ]
+        },
+        {
+          text: 'Core Functionality',
+          collapsed: false,
+          items: [
+            { text: 'How It Works', link: '/how-it-works' },
+            { text: 'Search Functionality', link: '/search-functionality' },
+            { text: 'Code Extraction', link: '/code-extraction' },
+            { text: 'CLI Mode', link: '/cli-mode' },
+          ]
+        },
+        {
+          text: 'AI Integration',
+          collapsed: false,
+          items: [
+            { text: 'AI Integration Overview', link: '/ai-integration' },
+            { text: 'AI Chat Mode', link: '/ai-chat' },
+            { text: 'MCP Server', link: '/mcp-server' },
+            { text: 'MCP Integration', link: '/mcp-integration' },
+            { text: 'Node.js SDK', link: '/nodejs-sdk' },
+            { text: 'Web Interface', link: '/web-interface' },
+          ]
+        },
+        {
+          text: 'Language Support',
+          collapsed: false,
+          items: [
+            { text: 'Language Support Overview', link: '/language-support-overview' },
+            { text: 'Supported Languages', link: '/supported-languages' },
+            { text: 'Adding Languages', link: '/adding-languages' },
+          ]
+        },
+        {
+          text: 'Advanced Topics',
+          collapsed: true,
+          items: [
+            { text: 'Result Ranking', link: '/result-ranking' },
+            { text: 'Pattern Matching', link: '/pattern-matching' },
+            { text: 'Performance Optimization', link: '/performance-optimization' },
+            { text: 'Customization', link: '/customization' },
+          ]
+        },
+        {
+          text: 'Contributing',
+          collapsed: true,
+          items: [
+            { text: 'Contributing Guide', link: '/contributing' },
+            { text: 'Code of Conduct', link: '/code-of-conduct' },
+            { text: 'Development Setup', link: '/development-setup' },
+          ]
+        },
+      ]
+    },
+    
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Quick Start', link: '/quick-start' },
+      { 
+        text: 'Documentation', 
+        items: [
+          { text: 'Getting Started', items: [
+            { text: 'Quick Start', link: '/quick-start' },
+            { text: 'Installation', link: '/installation' },
+            { text: 'Core Features', link: '/features' },
+          ]},
+          { text: 'Core Functionality', items: [
+            { text: 'How It Works', link: '/how-it-works' },
+            { text: 'Search Functionality', link: '/search-functionality' },
+            { text: 'Code Extraction', link: '/code-extraction' },
+            { text: 'CLI Mode', link: '/cli-mode' },
+          ]},
+          { text: 'AI Integration', items: [
+            { text: 'AI Integration Overview', link: '/ai-integration' },
+            { text: 'AI Chat Mode', link: '/ai-chat' },
+            { text: 'MCP Server', link: '/mcp-server' },
+            { text: 'MCP Integration', link: '/mcp-integration' },
+            { text: 'Node.js SDK', link: '/nodejs-sdk' },
+            { text: 'Web Interface', link: '/web-interface' },
+          ]},
+          { text: 'Language Support', items: [
+            { text: 'Language Support Overview', link: '/language-support-overview' },
+            { text: 'Supported Languages', link: '/supported-languages' },
+            { text: 'Adding Languages', link: '/adding-languages' },
+          ]},
+        ]
+      },
+      { text: 'GitHub', link: 'https://github.com/probelabs/probe' }
+    ],
+  }
+}
+```
+
+## Cross-Reference Guidelines
+
+Proper cross-referencing improves navigation, provides contextual understanding, reduces duplication, and ensures comprehensive coverage.
+
+### Cross-Reference Implementation
+
+When implementing cross-references, follow these guidelines:
+
+1. **Contextual References**: Include references where they make sense in the context of the document, not just at the end.
+
+2. **Descriptive Link Text**: Use descriptive link text that explains what the linked document contains:
+   ```markdown
+   Learn more about [how Probe works](/how-it-works)
+   ```
+   Instead of:
+   ```markdown
+   [how-it-works.md](/how-it-works)
+   ```
+
+3. **Section References**: When appropriate, link to specific sections within documents using anchor links:
+   ```markdown
+   [Search Syntax](/search-functionality#search-syntax)
+   ```
+
+4. **Related Topics Sections**: Include a "Related Topics" section at the end of each document that lists related documents.
+
+5. **Next Steps**: Where appropriate, include a "Next Steps" section that guides users to logical next documents to read.
+
+### Example Implementation
+
+Here's an example of how to implement these cross-references in a document:
+
+```markdown
+# Quick Start
+
+This guide will help you get up and running with Probe quickly.
+
+## Installation
+
+The easiest way to install Probe is via npm:
+
+```bash
+npm install -g @probelabs/probe@latest
+```
+
+For more detailed installation instructions, including manual installation and building from source, see the [Installation Guide](/installation).
+
+...
+
+## Next Steps
+
+- Learn more about the [CLI Mode](/cli-mode) for detailed command options
+- Explore the [AI Chat Mode](/ai-chat) for interactive code exploration
+- Check out the [Web Interface](/web-interface) for a browser-based experience
+- Understand [How It Works](/how-it-works) to get the most out of Probe
+
+## Related Topics
+
+- [Installation](/installation) - Detailed installation instructions
+- [CLI Mode](/cli-mode) - Command-line interface reference
+- [AI Chat Mode](/ai-chat) - Interactive CLI interface for asking questions about your code
+- [Web Interface](/web-interface) - Browser-based exploration
+```
+
+## Cross-Reference Map
+
+The following map shows how different documentation files should reference each other:
+
+### Getting Started Section
+
+- **index.md**
+  - Links to: quick-start.md, installation.md, features.md, how-it-works.md, ai-integration.md, language-support-overview.md
+  
+- **quick-start.md**
+  - Links to: installation.md, cli-mode.md, ai-chat.md, web-interface.md, how-it-works.md
+  - Referenced by: index.md, installation.md
+
+- **installation.md**
+  - Links to: quick-start.md, cli-mode.md
+  - Referenced by: index.md, quick-start.md
+
+- **features.md**
+  - Links to: how-it-works.md, search-functionality.md, code-extraction.md, ai-integration.md, language-support-overview.md
+  - Referenced by: index.md, how-it-works.md
+
+### Core Functionality Section
+
+- **how-it-works.md**
+  - Links to: search-functionality.md, code-extraction.md, features.md, language-support-overview.md
+  - Referenced by: index.md, features.md, search-functionality.md, code-extraction.md
+
+- **search-functionality.md**
+  - Links to: how-it-works.md, code-extraction.md, cli-mode.md
+  - Referenced by: how-it-works.md, features.md, cli-mode.md, language-support-overview.md
+
+- **code-extraction.md**
+  - Links to: how-it-works.md, search-functionality.md, language-support-overview.md
+  - Referenced by: how-it-works.md, features.md, search-functionality.md, language-support-overview.md
+
+- **cli-mode.md**
+  - Links to: search-functionality.md, code-extraction.md, installation.md
+  - Referenced by: quick-start.md, search-functionality.md, installation.md
+
+### AI Integration Section
+
+- **ai-integration.md**
+  - Links to: ai-chat.md, mcp-server.md, mcp-integration.md, nodejs-sdk.md, web-interface.md
+  - Referenced by: index.md, features.md
+
+- **ai-chat.md**
+  - Links to: ai-integration.md, nodejs-sdk.md
+  - Referenced by: ai-integration.md, quick-start.md, index.md
+
+- **mcp-server.md**
+  - Links to: ai-integration.md, mcp-integration.md
+  - Referenced by: ai-integration.md, mcp-integration.md
+
+- **mcp-integration.md**
+  - Links to: ai-integration.md, mcp-server.md
+  - Referenced by: ai-integration.md, index.md
+
+- **nodejs-sdk.md**
+  - Links to: ai-integration.md, ai-chat.md, web-interface.md
+  - Referenced by: ai-integration.md, index.md
+
+- **web-interface.md**
+  - Links to: ai-integration.md, nodejs-sdk.md
+  - Referenced by: ai-integration.md, quick-start.md
+
+### Language Support Section
+
+- **language-support-overview.md**
+  - Links to: supported-languages.md, adding-languages.md, search-functionality.md, code-extraction.md
+  - Referenced by: index.md, features.md, how-it-works.md
+
+- **supported-languages.md**
+  - Links to: language-support-overview.md, adding-languages.md
+  - Referenced by: language-support-overview.md
+
+- **adding-languages.md**
+  - Links to: language-support-overview.md, supported-languages.md
+  - Referenced by: language-support-overview.md
+
+## Maintenance Best Practices
+
+As the documentation evolves:
+
+1. **Update the cross-reference map** when adding new documentation files
+2. **Review existing cross-references** when updating documentation to ensure they remain relevant
+3. **Check for broken links** regularly
+4. **Ensure all document links are correct** and point to existing files
+5. **Update the navigation** when adding new documentation files
+6. **Maintain consistent formatting and style** across all documentation pages
+7. **Consider automating cross-reference validation** as part of the documentation build process

package/data/probe/site/contributing/documentation-structure.md

@@ -0,0 +1,75 @@
+# Documentation Structure
+
+This document outlines the organization of the Probe documentation and explains the reasoning behind its structure.
+
+## Three-Part Organization
+
+The Probe documentation is organized into three main sections, each serving a specific purpose and audience:
+
+### 1. Core Concepts & Setup
+
+**Purpose**: Cover what Probe is, how to install, and key concepts.
+
+**Audience**: Anyone new to Probe, or needing the big-picture overview.
+
+**Pages in this section**:
+- **What is Probe?** - Overview of core features, local privacy, AI readiness
+- **Installation** - Platform-specific installation instructions
+- **Quick Start** - Get up and running in minutes
+- **Language Support** - How Probe understands different languages
+- **Supported Languages** - List of languages with parsing capabilities
+- **How It Works** - Technical deep dive into Probe's architecture
+
+This section provides the foundation for understanding Probe. It answers the questions "What is it?", "How do I get it?", and "How does it work?" - giving users the context they need before diving into specific use cases.
+
+### 2. Use Cases / Workflows
+
+**Purpose**: Show how different user roles can integrate Probe into their workflow.
+
+**Audience**: Distinct user segments with different needs and integration patterns.
+
+**Pages in this section**:
+- **Using with AI Code Editors** - MCP integration and editor plugin setups
+- **Using in the CLI for Advanced AI** - CLI usage, scripting, and session-based caching
+- **Hosting a Team Chat** - Web interface usage and network configuration
+- **Building AI Tools with Node.js SDK** - SDK usage, LangChain, and custom tool building
+
+This section is scenario-based rather than feature-based. It recognizes that different users have different goals and workflows, and provides tailored guidance for each. By organizing around user roles and workflows, it helps users quickly find the information most relevant to their specific needs.
+
+### 3. Reference Documentation
+
+**Purpose**: Comprehensive "dictionary" of all commands, flags, environment variables, APIs, etc.
+
+**Audience**: Anyone needing direct reference or advanced/edge-case usage.
+
+**Pages in this section**:
+- **CLI Reference** - Command-line interface reference with all flags
+- **AI Integration Reference** - Environment variables, supported models, and usage patterns
+- **MCP Server Reference** - JSON schemas and tool call specifications
+- **Output Formats Reference** - JSON, XML, and other output formats
+- **Search Functionality** - Detailed search capabilities
+- **Code Extraction** - Extract meaningful code blocks
+- **Adding Languages** - Contribute support for new languages
+
+This section serves as a comprehensive reference for all of Probe's features and capabilities. It's designed for users who need detailed information about specific aspects of the tool, whether for advanced usage, troubleshooting, or integration.
+
+## Navigation Principles
+
+The documentation follows these key principles:
+
+1. **Progressive Disclosure**: Start with high-level concepts and gradually introduce more complex topics
+2. **Task-Oriented**: Organize information around what users are trying to accomplish
+3. **Role-Based**: Recognize that different users have different needs and workflows
+4. **Comprehensive Reference**: Provide detailed information for advanced users and edge cases
+
+## Cross-References
+
+Throughout the documentation, you'll find cross-references to related topics. These help you navigate between sections and find related information. For example, a use case page might reference specific CLI commands, which are documented in detail in the reference section.
+
+## Search Functionality
+
+The documentation includes a search feature that allows you to quickly find information across all pages. This is particularly useful when you're looking for specific features or concepts.
+
+## Feedback and Improvements
+
+This documentation structure is designed to evolve based on user feedback. If you have suggestions for improving the organization or content of the documentation, please [open an issue](https://github.com/probelabs/probe/issues) on GitHub.

package/data/probe/site/documentation-cross-references.md

@@ -0,0 +1,215 @@
+# Documentation Cross-References
+
+This guide explains how to maintain cross-references between different sections of the Probe documentation. Proper cross-referencing is essential for helping users navigate the documentation and find related information.
+
+## Importance of Cross-References
+
+Cross-references serve several important purposes:
+
+1. **Navigation**: Help users move between related topics
+2. **Context**: Provide additional context for complex topics
+3. **Completeness**: Ensure users can find all relevant information
+4. **Coherence**: Create a unified documentation experience
+
+## Types of Cross-References
+
+The Probe documentation uses several types of cross-references:
+
+### 1. Section Links
+
+Links between major sections of the documentation:
+
+```markdown
+For more information on installation, see the [Core Concepts & Setup](/installation) section.
+```
+
+### 2. Related Topics
+
+Links to related topics within the same section:
+
+```markdown
+Learn more about [search patterns](/search-functionality#patterns) to improve your search results.
+```
+
+### 3. Workflow Connections
+
+Links that connect different parts of a workflow:
+
+```markdown
+After [setting up the MCP server](/mcp-server#setting-up-the-mcp-server), you can [integrate it with your AI editor](/mcp-integration#editor-integration).
+```
+
+### 4. Reference Links
+
+Links to reference documentation for specific features:
+
+```markdown
+See the [CLI Reference](/cli-mode#search-command) for a complete list of search options.
+```
+
+## Cross-Reference Patterns
+
+When adding cross-references, follow these patterns:
+
+### Between Core Concepts and Use Cases
+
+Core Concepts pages should link to relevant Use Cases:
+
+```markdown
+# Language Support
+
+[...content...]
+
+## Using in Your Workflow
+
+Once you understand the supported languages, you can:
+
+- [Use Probe with AI Code Editors](/mcp-integration) for intelligent code assistance
+- [Build custom tools with the Node.js SDK](/nodejs-sdk) for language-specific processing
+```
+
+Use Cases should link back to relevant Core Concepts:
+
+```markdown
+# Using with AI Code Editors
+
+[...content...]
+
+This integration relies on Probe's [language parsing capabilities](/language-support-overview) to provide accurate code context.
+```
+
+### Between Use Cases and Reference
+
+Use Cases should link to relevant Reference documentation:
+
+```markdown
+# Using in the CLI for Advanced AI
+
+[...content...]
+
+For a complete list of CLI options, see the [CLI Reference](/cli-mode).
+```
+
+Reference documentation should mention relevant Use Cases:
+
+```markdown
+# CLI Reference
+
+[...content...]
+
+These commands are commonly used in [AI chat workflows](/ai-chat) and when [building custom tools](/nodejs-sdk).
+```
+
+## Maintaining Cross-References
+
+When updating the documentation structure, follow these guidelines to maintain cross-references:
+
+### 1. Update Links When Moving Pages
+
+If you move a page to a new location, update all links to that page:
+
+```bash
+# Find all links to a specific page
+grep -r "\[.*\](\/old-page-path)" site/
+```
+
+### 2. Check for Broken Links
+
+Regularly check for broken links in the documentation:
+
+```bash
+# Using a tool like linkcheck
+npx linkcheck https://probe-docs.example.com
+```
+
+### 3. Add Context to Links
+
+When adding a link, include context about what the user will find:
+
+```markdown
+# Good
+For details on output formatting, see the [Output Formats Reference](/output-formats).
+
+# Better
+For details on how to format search results as JSON or XML, see the [Output Formats Reference](/output-formats#json-and-xml).
+```
+
+### 4. Use Anchor Links
+
+Link to specific sections of a page when appropriate:
+
+```markdown
+See the [search command options](/cli-mode#search-options) for more details.
+```
+
+## Cross-Reference Map
+
+The following table shows the key cross-references between different sections of the documentation:
+
+| From | To | Purpose |
+|------|-------|---------|
+| Core Concepts → | Use Cases | Show how concepts are applied in practice |
+| Use Cases → | Core Concepts | Provide background on underlying concepts |
+| Use Cases → | Reference | Point to detailed technical information |
+| Reference → | Use Cases | Show practical applications of technical features |
+
+## Examples of Effective Cross-References
+
+### Example 1: From Core Concepts to Use Cases
+
+```markdown
+# What is Probe?
+
+[...content about Probe's features...]
+
+## Real-World Applications
+
+Probe can be used in various workflows:
+
+- For AI-assisted coding, see [Using with AI Code Editors](/mcp-integration)
+- For team collaboration, see [Hosting a Team Chat](/web-interface)
+- For custom AI tools, see [Building AI Tools with Node.js SDK](/nodejs-sdk)
+```
+
+### Example 2: From Use Cases to Reference
+
+```markdown
+# Using in the CLI for Advanced AI
+
+[...content about CLI usage...]
+
+## Advanced Configuration
+
+For advanced use cases, you can configure various aspects of the CLI:
+
+- For output formatting options, see [Output Formats Reference](/output-formats)
+- For search pattern syntax, see [Search Functionality](/search-functionality#patterns)
+- For environment variables, see [AI Integration Reference](/ai-integration#configuration-options)
+```
+
+### Example 3: From Reference to Core Concepts and Use Cases
+
+```markdown
+# CLI Reference
+
+[...command reference...]
+
+## Background
+
+The CLI commands are built on Probe's [core search technology](/how-it-works#search-technology).
+
+## Common Workflows
+
+These commands are commonly used in:
+
+- [AI chat sessions](/ai-chat) for interactive code exploration
+- [Custom AI tools](/nodejs-sdk) for automated code analysis
+```
+
+## Best Practices Summary
+
+1. **Be Specific**: Link to the most specific section that contains the relevant information
+2. **Add Context**: Explain what the user will find at the linked location
+3. **Maintain Bidirectional Links**: Ensure that related topics link to each other
+4. **Check Regularly**: Verify that links remain valid as the documentation evolves
+5. **Use Consistent Language**: Use consistent phrasing for similar types of cross-references

package/data/probe/site/documentation-guide.md

@@ -0,0 +1,132 @@
+# Probe Documentation Guide
+
+This guide helps you navigate the Probe documentation and find the information you need.
+
+## Documentation Structure
+
+The Probe documentation is organized into three main sections:
+
+### Core Concepts & Setup
+
+This section covers what Probe is, how to install it, and key concepts.
+
+- [What is Probe?](/features) - Overview of Probe's core features, local privacy, and AI readiness
+- [Installation](/installation) - Detailed installation instructions for all platforms
+- [Quick Start](/quick-start) - Get up and running with Probe in minutes
+- [Language Support](/language-support-overview) - How Probe understands different languages
+- [Supported Languages](/supported-languages) - List of supported programming languages
+- [How It Works](/how-it-works) - The technology behind Probe
+
+### Use Cases / Workflows
+
+This section shows how different user roles can integrate Probe into their workflow.
+
+- [Using with AI Code Editors](/mcp-integration) - MCP integration and editor plugin setups
+- [Using in the CLI for Advanced AI](/ai-chat) - CLI usage, scripting, and session-based caching
+- [Hosting a Team Chat](/web-interface) - Web interface usage and network configuration
+- [Building AI Tools with Node.js SDK](/nodejs-sdk) - SDK usage, LangChain, and custom tool building
+
+### Reference Documentation
+
+This section provides comprehensive reference for all commands, flags, APIs, etc.
+
+- [CLI Reference](/cli-mode) - Command-line interface reference with all flags
+- [AI Integration Reference](/ai-integration) - Environment variables, supported models, and usage patterns
+- [MCP Server Reference](/mcp-server) - JSON schemas and tool call specifications
+- [Output Formats Reference](/output-formats) - JSON, XML, and other output formats
+- [Search Functionality](/search-functionality) - Detailed search capabilities
+- [Code Extraction](/code-extraction) - Extract meaningful code blocks
+- [Adding Languages](/adding-languages) - Contribute support for new languages
+- [Documentation Maintenance](/documentation-maintenance) - For documentation maintainers
+
+### Contributing
+
+- [Contributing Guide](https://github.com/probelabs/probe/blob/main/CONTRIBUTING.md) - How to contribute to Probe
+- [Code of Conduct](https://github.com/probelabs/probe/blob/main/CODE_OF_CONDUCT.md) - Community guidelines
+
+## How to Use This Documentation
+
+### For New Users
+
+If you're new to Probe, we recommend following this path:
+
+1. Start with [What is Probe?](/features) to understand the tool's capabilities
+2. Follow the [Installation](/installation) guide to get Probe set up
+3. Use the [Quick Start](/quick-start) guide to get up and running quickly
+4. Choose a workflow that matches your needs from the Use Cases section
+5. Refer to the Reference Documentation for detailed information as needed
+
+### For Different User Roles
+
+- **AI Code Editor Users**: Start with [Using with AI Code Editors](/mcp-integration)
+- **CLI Power Users**: Check out [Using in the CLI for Advanced AI](/ai-chat)
+- **Enterprise/Team Users**: See [Hosting a Team Chat](/web-interface)
+- **AI Tooling Developers**: Begin with [Building AI Tools with Node.js SDK](/nodejs-sdk)
+
+### Finding Information
+
+There are several ways to find information in the documentation:
+
+1. **Navigation Menu**: Use the sidebar navigation to browse the documentation by section
+2. **Search**: Use the search box in the top right to find specific topics
+3. **Cross-References**: Follow links within documentation pages to related topics
+4. **Home Page**: The [home page](/) provides an overview of key features
+
+## Documentation Conventions
+
+Throughout the documentation, we use the following conventions:
+
+### Code Examples
+
+Code examples are shown in code blocks:
+
+```bash
+probe search "error handling" ./src
+```
+
+### Command Examples
+
+Command examples are shown using the `<CommandExample>` component:
+
+<CommandExample>probe search "error handling" ./src</CommandExample>
+
+### Code Editors
+
+Code snippets are shown using the `<CodeEditor>` component:
+
+<CodeEditor filePath="example.js">
+function handleError(error) {
+  console.error(`Error: ${error.message}`);
+  return { success: false, error: error.message };
+}
+</CodeEditor>
+
+### Notes and Warnings
+
+Important information is highlighted using note blocks:
+
+:::info
+This is an informational note that provides additional context.
+:::
+
+:::warning
+This is a warning that highlights potential issues or important considerations.
+:::
+
+:::tip
+This is a tip that provides helpful advice or best practices.
+:::
+
+## Contributing to the Documentation
+
+We welcome contributions to the Probe documentation. If you find errors, omissions, or have suggestions for improvements, please consider contributing:
+
+1. Fork the [Probe repository](https://github.com/probelabs/probe) on GitHub
+2. Make your changes to the documentation files in the `site` directory
+3. Submit a pull request with your changes
+
+For more information on contributing, see the [Contributing Guide](https://github.com/probelabs/probe/blob/main/CONTRIBUTING.md).
+
+## Feedback
+
+If you have feedback on the documentation, please [open an issue](https://github.com/probelabs/probe/issues) on GitHub or reach out to the maintainers.