Skip to content

README.md

Latest commit

 

History

History
96 lines (64 loc) · 1.5 KB

README.md

File metadata and controls

96 lines (64 loc) · 1.5 KB
Raw

ObservecO Documentation

Complete documentation for ObservecO products

Quick Start

This repository contains all documentation for ObservecO products using Docusaurus.

Local Development

# Install dependencies
npm install

# Start dev server
npm run start

# Open http://localhost:3000

Build

# Build static site
npm run build

# Serve built site
npm run serve

Documentation Structure

docs/
├── docs/                   # Documentation pages
│   ├── intro/             # Introduction
│   ├── pulse/             # Observe Pulse docs
│   ├── context/           # Observe Context docs
│   ├── dashboard/         # Observe Dashboard docs
│   └── api/               # API reference
├── blog/                  # Blog posts
├── static/                # Static assets
└── src/                   # Docusaurus source

Contributing

  1. Fork the repository
  2. Create a documentation page in docs/
  3. Add sidebar entries in sidebars.js
  4. Open a Pull Request

Documentation Guides

Writing Documentation

  • Use clear, simple language
  • Include code examples
  • Add screenshots where helpful
  • Keep pages focused on one topic

Code Blocks

Use triple backticks with language specification:

```bash
npm install
```

Images

Place images in static/img/:

![Screenshot](/img/screenshot.png)

License

MIT License

ObservecO - Documented for clarity.