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
Metadata
Release files for kb-dashboard-docs 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kb_dashboard_docs-0.4.1.tar.gz | 70.0 kB | Without provenance | Details for kb_dashboard_docs-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kb_dashboard_docs-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for kb_dashboard_docs-0.4.1-py3-none-any.whl |
Total release size: 147.5 kB
Release files / kb_dashboard_docs-0.4.1.tar.gz
| Download URL | kb_dashboard_docs-0.4.1.tar.gz |
|---|---|
| Size | 70.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b8ce356f72af06b57a6cc2fb5bf7ada8c9aed2d22ef03084d54c5936a073007a
|
|
BLAKE2b-256 checksum How to use checksums |
84aaf4358814ebe5744bf6f1336eeb6ec6429d6d42766d1fadbe28c856266ef7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|
Release files / kb_dashboard_docs-0.4.1-py3-none-any.whl
| Download URL | kb_dashboard_docs-0.4.1-py3-none-any.whl |
|---|---|
| Size | 77.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25cd08bb782a41c6476b85477166dc311803f765d548cc9abee9fe885f400c44
|
|
BLAKE2b-256 checksum How to use checksums |
74fcdd71e003adaab8173302a242e75e1728dca15d77f3b43a9e6514d8edea6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|
Security for kb-dashboard-docs 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.