Skip to content

catbee-technologies/catbee-docs

Catbee Docs

Welcome to the official documentation repository for Catbee Technologies.

This project contains all documentation pages, guides, examples, and the Docusaurus-based website used for publishing Catbee documentation.


📘 Overview

This repository includes:

  • Documentation for Catbee libraries and tooling
  • Guides, FAQs, best practices
  • API references (where applicable)
  • Architecture and workflow explanations
  • Examples and code snippets
  • The full source of the Docusaurus documentation site

🚀 Getting Started

1. Install Dependencies

npm install

2. Start Local Development Server

npm run start

This starts a local dev server at http://localhost:3000 with hot reload.

3. Build Documentation

npm run build

This generates the static site inside the build/ directory.


🧩 Project Structure

catbee-docs/
├── docs/                 # Main documentation pages (MD/MDX)
├── src/                  # Docusaurus customizations and components
├── static/               # Static assets (images, logos, files)
├── docusaurus.config.js  # Site configuration
└── sidebars.ts           # Sidebar navigation

🛠️ Contributing

We welcome contributions!
Before submitting a PR, please read our contributing guide:

👉 CONTRIBUTING.md

To open issues:

  • Use Bug Report template for documentation/site issues
  • Use Feature Request template for proposing improvements

🔒 Security

Since this is a docs-only repository, security issues are rare.
If you discover something concerning (private data, config leak, etc.):

Contact: security@catbee.in

More info:
👉 SECURITY.md


📝 License

MIT License © Catbee Technologies
See LICENSE for details.


💙 Thanks

Thank you for contributing to Catbee Docs!
Your contributions help make the Catbee ecosystem clearer and more accessible for developers around the world.