Setup Readthedocs and create documentation (#3)

* Fix quickstart URL

* Setup readthedocs build

* Setup index in markdonw

* Setup Sphinx build and layout

* Begin writing documentation for public users

* Create Userguide for dashboards. Add todos for remaining files

* Add Full install, exporters, and alerting docs

Author: alhendrickson

.gitignore

@@ -1,6 +1,6 @@
 # Custom ignores
 observability/examples/simple/observability-simple
-
+_build
 
 # Python ignores
 # Byte-compiled / optimized / DLL files

.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/screenshots-dashboards-alerts.png

@@ -0,0 +1,37 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../observability/docs"))
+
+print("Hello")
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'CogStack Platform Toolkit'
+copyright = '2025, CogStack Org'
+author = 'CogStack Org'
+release = 'latest'
+html_title = "CogStack Platform Toolkit"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx_rtd_theme',
+    'sphinx.ext.autodoc',
+    'myst_parser',
+    'sphinx.ext.inheritance_diagram',
+]
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ['_static']

docs/_static/screenshots-dashboards-availability.png

@@ -0,0 +1,15 @@
+   
+# Cogstack Platform Toolit
+
+This project provides utilities for running Cogstack in production.
+
+- [CogStack Observability](observability/_index.md) 
+
+```{toctree}
+:hidden:
+
+observability/_index
+
+```
+
+