Where to Find holaOS Documentation: Official Guides and Developer Resources

You can access holaOS documentation through the official website at holaos.ai/docs or directly in the repository's docs/ directory, which contains the complete source for the online site plus additional architectural specifications and design plans.

The holaOS project maintains a dual documentation strategy according to the holaboss-ai/holaOS source code. The public-facing website offers polished, searchable guides for end users, while the docs/ folder in the repository provides developers with raw Markdown sources, internal design documents, and forward-looking implementation plans.

Official Online Documentation

The primary user-facing holaOS documentation is hosted at https://www.holaos.ai/docs/getting-started, as referenced in the repository's README.md (lines 31-34). This portal contains comprehensive resources including the Getting Started guide, API references, step-by-step tutorials, and UI walkthroughs designed for both new users and experienced developers.

Repository Documentation Structure

The docs/ directory at the repository root holds the full source of the online documentation, plus a large collection of design specifications and internal planning documents. You can browse these files directly on GitHub or clone the repository for local access.

Core Documentation Files

Several Markdown files in the docs/ directory provide deep technical guidance:

• docs/plugin-sdk.md – Explains how to write, package, and publish plugins for the holaOS ecosystem
• docs/workspace-removal.md – Describes the complete workflow and technical implementation for deleting workspaces
• docs/plans/* – Contains forward-looking design and implementation roadmaps, such as docs/plans/2026-04-07-module-improvement-roadmap.md

Documentation Site Source

The apps/docs/README.md file contains technical documentation for the documentation website itself, explaining how the apps/docs workspace powers the hosted site. This is useful for contributors who need to understand the build process or modify the documentation platform.

Accessing Documentation Programmatically

You can load holaOS documentation programmatically for custom tooling or automated help systems.

To fetch the online documentation index using Node.js:

// Example: fetch the online docs index (Node.js)
import https from 'https';

function getDocsIndex() {
  https.get('https://www.holaos.ai/docs/getting-started', (res) => {
    let data = '';
    res.on('data', chunk => (data += chunk));
    res.on('end', () => console.log('Docs HTML length:', data.length));
  });
}
getDocsIndex();

To open local documentation files from the command line:

# Example: open a local Markdown file in the repo (Unix)

open docs/plugin-sdk.md   # macOS

xdg-open docs/plugin-sdk.md   # Linux

Summary

• Primary website: Access user guides and API references at https://www.holaos.ai/docs/getting-started
• Source files: The docs/ directory contains the raw Markdown source and additional technical specifications
• Plugin development: See docs/plugin-sdk.md for extension authoring guidelines
• Architecture plans: Review docs/plans/ for upcoming features and system design documents
• Site generation: Consult apps/docs/README.md for details on the documentation platform implementation

Frequently Asked Questions

Where is the holaOS getting started guide located?

The main getting started guide is hosted at https://www.holaos.ai/docs/getting-started, with the source Markdown files available in the repository's docs/ directory. The README.md file (lines 31-34) contains the direct link to this resource, making it the entry point for new users.

How do I find the plugin development documentation for holaOS?

Plugin development instructions are documented in docs/plugin-sdk.md in the repository root. This file explains how to write, package, and publish plugins for the holaOS ecosystem, and is accessible both through the online documentation site and directly on GitHub.

What are the files in the docs/plans directory?

The docs/plans/ directory contains long-form design and implementation roadmaps used by the holaOS development team. These documents outline future architectural decisions and feature improvements, such as the module improvement roadmap dated 2026-04-07, providing insight into the project's technical direction.

Can I read the holaOS documentation offline?

Yes. Since the full documentation source resides in the docs/ directory as Markdown files, you can clone the holaboss-ai/holaOS repository and access all content locally. Use standard Markdown viewers or text editors to read files like docs/workspace-removal.md and docs/plugin-sdk.md without an internet connection.

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