Where to Find rowboatlabs/rowboat Documentation: A Complete Guide

You can find rowboatlabs/rowboat documentation in the root README.md for project overviews, the apps/docs directory for comprehensive user guides, and the Python SDK README for API references.

The rowboatlabs/rowboat repository is a monorepo containing multiple applications including an Electron app, Next.js dashboards, a CLI tool, and a Python SDK. Whether you are setting up the project for the first time or integrating the Python SDK, locating the correct documentation is essential for efficient development.

Primary Documentation Locations

Root README.md

The main entry point for all developers is the root README.md file. This document provides a high-level overview of the project architecture, installation steps, and a quick start guide. It also contains links to the various applications within the monorepo, including the Electron app, Next.js dashboards, CLI, and Python SDK.

User Documentation Site (apps/docs)

For comprehensive user-facing documentation, navigate to the apps/docs directory. This folder contains the complete source for the documentation website, including markdown files, images, and video assets. The apps/docs/docs.json file serves as the table of contents and metadata manifest for the docs site, organizing individual markdown pages located in apps/docs/docs/*.md. Video tutorials are stored in apps/docs/docs/videos/.

Python SDK Documentation

Developers integrating with the Python SDK should consult apps/python-sdk/README.md. This file contains installation instructions, API reference details, and example usage patterns for the SDK. It serves as the primary technical reference for programmatic interactions with the Rowboat platform.

CLI Development Notes

For contributors working on the command-line interface, apps/cli/todo.md contains development notes, planned features, and current TODOs. While not formal user documentation, this file provides valuable context for understanding the CLI's roadmap and implementation details.

Experimental Tools

The apps/experimental/ directory houses sample projects and experimental tools, each containing their own README files with specific usage instructions. These documents are essential for developers exploring cutting-edge features or contributing to experimental functionality.

Navigating the Documentation Structure

Understanding the organization of apps/docs helps you locate specific information quickly. The docs.json manifest defines the navigation hierarchy, while individual markdown files in apps/docs/docs/ contain feature-specific guides, UI walkthroughs, and API usage examples. This structure allows the documentation site to be built as a static site while maintaining source control alongside the application code.

Accessing Documentation Programmatically

You can access rowboatlabs/rowboat documentation directly from your terminal or scripts.

Open the root README in your default browser:

open https://github.com/rowboatlabs/rowboat/blob/main/README.md

Clone the repository and serve the documentation locally:

git clone https://github.com/rowboatlabs/rowboat.git
cd rowboat/apps/docs
npx serve .

Fetch documentation content programmatically using Node.js:

import fetch from 'node-fetch';

const url = 'https://raw.githubusercontent.com/rowboatlabs/rowboat/main/apps/docs/docs/introduction.md';
const response = await fetch(url);
const markdown = await response.text();
console.log(markdown.slice(0, 200)); // preview first 200 chars

Summary

• The root README.md provides the primary entry point with installation and quick start instructions.
• Comprehensive user guides reside in apps/docs, organized by docs.json and stored as markdown in apps/docs/docs/.
• API-specific documentation for the Python SDK is located in apps/python-sdk/README.md.
• Development notes and experimental features are documented in apps/cli/todo.md and apps/experimental/ respectively.

Frequently Asked Questions

Where is the main documentation entry point for rowboatlabs/rowboat?

The main entry point is the root README.md file in the repository. It contains the high-level project overview, installation steps, and links to all component-specific documentation including the docs site, Python SDK, and CLI tools.

How is the documentation site structured in the repository?

The documentation site source lives in apps/docs. The docs.json file acts as the table of contents, while individual content pages are stored as markdown files in apps/docs/docs/. Video assets are kept in apps/docs/docs/videos/.

Where can I find API documentation for the Python SDK?

API documentation for the Python SDK is located in apps/python-sdk/README.md. This file includes installation instructions, method signatures, and example usage patterns for integrating with the Rowboat platform programmatically.

Are there docs for experimental features in rowboatlabs/rowboat?

Yes, experimental features are documented within the apps/experimental/ directory. Each experimental tool or sample project includes its own README file with specific setup instructions and usage guidelines for developers exploring cutting-edge functionality.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}