Documentation and bundled LLM content for kb-yaml-to-lens
Project description
kb-dashboard-docs
Documentation and bundled LLM content for kb-yaml-to-lens dashboard compiler.
Overview
This package provides:
- MkDocs documentation site - User-facing documentation for the kb-yaml-to-lens project
- Bundled LLM content - Pre-processed documentation for LLM context windows
Installation
pip install kb-dashboard-docs
Or for the full CLI experience:
pip install kb-dashboard-cli
API Usage
from kb_dashboard_docs import get_full_docs, list_guides, get_guide
# Get complete documentation for LLM context
full_docs = get_full_docs()
# List available workflow guides
guides = list_guides()
# ['breaking-changes', 'color-assignments', 'dashboard-decompiling-guide', ...]
# Get a specific guide
otel_guide = get_guide('otel-dashboard-guide')
CLI Usage
When using kb-dashboard-cli:
# Output full documentation (for piping to LLMs)
kb-dashboard docs llms-full
# Copy to clipboard (macOS)
kb-dashboard docs llms-full | pbcopy
# List available guides
kb-dashboard docs list-guides
# Get a specific guide
kb-dashboard docs guide otel-dashboard-guide
Available Guides
- breaking-changes - Release-to-release migration checklist and compatibility notes
- otel-dashboard-guide - Creating dashboards from OpenTelemetry Collector data
- esql-language-reference - ES|QL query language reference for dashboards
- dashboard-decompiling-guide - Converting Kibana JSON dashboards to YAML
- dashboard-style-guide - Layout, sizing, and design patterns
- color-assignments - Advanced chart color assignment strategies
- esql-views - Advanced ES|QL view patterns for chart panels
- legend-configuration - Advanced legend configuration for supported charts
Development
See DEVELOPING.md for development setup.
License
MIT
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
kb_dashboard_docs-0.4.1.tar.gz
(70.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kb_dashboard_docs-0.4.1.tar.gz.
File metadata
- Download URL: kb_dashboard_docs-0.4.1.tar.gz
- Upload date:
- Size: 70.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b8ce356f72af06b57a6cc2fb5bf7ada8c9aed2d22ef03084d54c5936a073007a
|
|
| MD5 |
914df51670a62f68252992f20138aff1
|
|
| BLAKE2b-256 |
84aaf4358814ebe5744bf6f1336eeb6ec6429d6d42766d1fadbe28c856266ef7
|
File details
Details for the file kb_dashboard_docs-0.4.1-py3-none-any.whl.
File metadata
- Download URL: kb_dashboard_docs-0.4.1-py3-none-any.whl
- Upload date:
- Size: 77.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25cd08bb782a41c6476b85477166dc311803f765d548cc9abee9fe885f400c44
|
|
| MD5 |
242e8105d79b4ebc2d6bd8e0cd58e29c
|
|
| BLAKE2b-256 |
74fcdd71e003adaab8173302a242e75e1728dca15d77f3b43a9e6514d8edea6d
|
