From 0830a57fa629466e5e846e1cc185d23473e7c54a Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Thu, 18 Dec 2025 13:48:28 -0800 Subject: [PATCH] feat(docs): add llms.txt for LLM-friendly documentation index (#36730) Co-authored-by: Claude Opus 4.5 --- .rat-excludes | 1 + docs/static/llms.txt | 64 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 docs/static/llms.txt diff --git a/.rat-excludes b/.rat-excludes index aacc16ec5cd..afe8329057c 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -86,6 +86,7 @@ intro_header.txt # for LLMs llm-context.md +llms.txt AGENTS.md LLMS.md CLAUDE.md diff --git a/docs/static/llms.txt b/docs/static/llms.txt new file mode 100644 index 00000000000..d4bdfc9406a --- /dev/null +++ b/docs/static/llms.txt @@ -0,0 +1,64 @@ +# Apache Superset + +> Apache Superset is a modern, enterprise-ready business intelligence web application. It provides a no-code interface for building charts, a powerful SQL editor, support for nearly any SQL database, and beautiful visualizations. Superset is open source under the Apache 2.0 license. + +Superset is designed for data exploration and visualization at scale. It features a lightweight semantic layer, configurable caching, extensible security with RBAC, a REST API for programmatic access, and a cloud-native architecture. + +## Getting Started + +- [Introduction](https://superset.apache.org/docs/intro): Overview of Superset features, supported databases, and resources +- [Quickstart](https://superset.apache.org/docs/quickstart): Get Superset running quickly with Docker Compose + +## Installation + +- [Architecture](https://superset.apache.org/docs/installation/architecture): Production deployment architecture and components +- [Docker Compose](https://superset.apache.org/docs/installation/docker-compose): Install Superset using Docker Compose +- [Docker Builds](https://superset.apache.org/docs/installation/docker-builds): Building and customizing Docker images +- [Kubernetes](https://superset.apache.org/docs/installation/kubernetes): Deploy Superset on Kubernetes with Helm +- [PyPI](https://superset.apache.org/docs/installation/pypi): Install from PyPI using pip +- [Upgrading Superset](https://superset.apache.org/docs/installation/upgrading-superset): Upgrade between Superset versions + +## Configuration + +- [Configuring Superset](https://superset.apache.org/docs/configuration/configuring-superset): Main configuration options and superset_config.py +- [Databases](https://superset.apache.org/docs/configuration/databases): Connect to databases with SQLAlchemy connection strings +- [Caching](https://superset.apache.org/docs/configuration/cache): Configure caching with Redis or other backends +- [Async Queries & Celery](https://superset.apache.org/docs/configuration/async-queries-celery): Set up async query execution with Celery +- [Alerts & Reports](https://superset.apache.org/docs/configuration/alerts-reports): Configure email/Slack alerts and scheduled reports +- [SQL Templating](https://superset.apache.org/docs/configuration/sql-templating): Use Jinja templates in SQL queries +- [Theming](https://superset.apache.org/docs/configuration/theming): Customize Superset's appearance +- [Networking Settings](https://superset.apache.org/docs/configuration/networking-settings): CORS, proxy, and network configuration +- [Timezones](https://superset.apache.org/docs/configuration/timezones): Timezone handling configuration +- [Event Logging](https://superset.apache.org/docs/configuration/event-logging): Configure event and analytics logging +- [Importing/Exporting Datasources](https://superset.apache.org/docs/configuration/importing-exporting-datasources): Import and export datasource definitions + +## Using Superset + +- [Creating Your First Dashboard](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard): Step-by-step tutorial for building dashboards +- [Exploring Data](https://superset.apache.org/docs/using-superset/exploring-data): Guide to data exploration features +- [Issue Codes](https://superset.apache.org/docs/using-superset/issue-codes): Reference for Superset error codes + +## Security + +- [Security Overview](https://superset.apache.org/docs/security/security): RBAC, row-level security, and authentication options +- [Securing Superset](https://superset.apache.org/docs/security/securing_superset): Production security hardening guide +- [CVEs](https://superset.apache.org/docs/security/cves): Security vulnerabilities and advisories + +## Contributing + +- [Contributing Guide](https://superset.apache.org/docs/contributing/contributing): How to contribute to Apache Superset +- [Development Environment](https://superset.apache.org/docs/contributing/development): Set up a local development environment +- [Guidelines](https://superset.apache.org/docs/contributing/guidelines): Code style, testing, and PR guidelines +- [How-Tos](https://superset.apache.org/docs/contributing/howtos): Common development tasks and recipes +- [Resources](https://superset.apache.org/docs/contributing/resources): Additional contributor resources + +## Reference + +- [FAQ](https://superset.apache.org/docs/faq): Frequently asked questions +- [REST API](https://superset.apache.org/docs/api): Superset REST API documentation + +## Optional + +- [Country Map Tools](https://superset.apache.org/docs/configuration/country-map-tools): Custom country map visualizations +- [Map Tiles](https://superset.apache.org/docs/configuration/map-tiles): Configure map tile providers for deck.gl charts +- [Miscellaneous](https://superset.apache.org/docs/contributing/misc): Additional contributor information