[FEAT] Add platform documentation

[martian56]

This pull request introduces comprehensive documentation for the ChatOps project, including both user/developer guides and detailed API references. It also sets up an automated workflow for deploying documentation to Cloudflare Pages on changes to documentation files. The most important changes are grouped below:

Documentation Infrastructure:

• Added a GitHub Actions workflow (.github/workflows/docs-deploy.yml) to automatically build and deploy MkDocs documentation to Cloudflare Pages on pushes to the main branch or manual dispatch.
• Updated .gitignore in the docs directory to exclude build artifacts such as site/ and .cache/ from version control.

Developer and User Documentation:

• Added a detailed README.md in the docs directory, explaining how to build, serve, and contribute to the documentation, as well as outlining the documentation structure and deployment process.
• Created comprehensive agent documentation, including:
  • Overview, features, architecture, and troubleshooting (docs/agent/index.md)
  • Installation instructions for multiple platforms and service setup (docs/agent/installation.md)
  • Configuration methods and options (docs/agent/configuration.md)
  • Development guide with project structure and contribution guidelines (docs/agent/development.md)

API Reference Documentation:

• Added a full API reference, covering:
  • General API overview and authentication methods (docs/api/index.md)
  • Authentication flows for users and agents, including JWT and API key usage (docs/api/authentication.md)
  • API key management and best practices (docs/api/api-keys.md)
  • REST API endpoints with example requests/responses and error handling (docs/api/rest-endpoints.md)

These changes collectively establish a robust documentation system, making it easier for users and developers to understand, install, configure, and extend ChatOps, as well as consume its API.

Closes #23

[valiyyaddin]

amazing work done!keep up

[Copilot]

Pull request overview

This pull request introduces comprehensive documentation infrastructure for the ChatOps project, including MkDocs-based documentation, automated deployment to Cloudflare Pages, and detailed guides covering all aspects of the platform.

Summary: The PR establishes a complete documentation system with user guides, API references, architecture documentation, and deployment instructions. It sets up automated deployment via GitHub Actions and provides well-structured content for developers, users, and operators.

Key Changes:

• Added MkDocs configuration with Material theme and comprehensive navigation structure
• Created automated GitHub Actions workflow for deploying documentation to Cloudflare Pages
• Added extensive documentation covering getting started, architecture, API reference, agent setup, frontend, deployment, and contributing guidelines

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
mkdocs.yml	MkDocs configuration with navigation structure, theme settings, and plugins
.github/workflows/docs-deploy.yml	GitHub Actions workflow for automated documentation deployment to Cloudflare Pages
docs/requirements.txt	Python dependencies for building documentation (MkDocs, Material theme, plugins)
docs/index.md	Main documentation homepage with overview and navigation
docs/README.md	Instructions for building and contributing to documentation
docs/.gitignore	Excludes build artifacts (site/, .cache/) from version control
.gitignore	Added documentation build artifacts to root gitignore
docs/getting-started/*.md	Getting started guides including quick start and installation instructions
docs/technologies/*.md	Technology stack documentation for backend, frontend, and agent
docs/api/*.md	Complete API reference including REST endpoints, WebSocket API, and authentication
docs/agent/*.md	Agent documentation covering installation, configuration, and development
docs/architecture/*.md	System architecture documentation with diagrams and data flow
docs/frontend/*.md	Frontend setup and overview documentation
docs/deployment/*.md	Deployment guides for Docker and production environments
docs/contributing/*.md	Contributing guidelines including development setup and testing

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[valiyyaddin]

amazing