Skip to content

Latest commit

 

History

History
132 lines (87 loc) · 5.09 KB

documentation-guide.md

File metadata and controls

132 lines (87 loc) · 5.09 KB

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.

Use Cases / Workflows

This section shows how different user roles can integrate Probe into their workflow.

Reference Documentation

This section provides comprehensive reference for all commands, flags, APIs, etc.

Contributing

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? to understand the tool's capabilities
  2. Follow the Installation guide to get Probe set up
  3. Use the 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

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:

probe search "error handling" ./src

Command Examples

Command examples are shown using the <CommandExample> component:

probe search "error handling" ./src

Code Editors

Code snippets are shown using the <CodeEditor> component:

function handleError(error) { console.error(`Error: ${error.message}`); return { success: false, error: error.message }; }

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

Feedback

If you have feedback on the documentation, please open an issue on GitHub or reach out to the maintainers.