codeant-ai-for-open-source[bot] commented on PR #36805:
URL: https://github.com/apache/superset/pull/36805#issuecomment-3753101219
## **Sequence Diagram**
This PR centralizes database docs in superset/db_engine_specs/lib.py and
adds a generation step that merges engine-spec metadata and the DATABASE_DOCS
dict to produce JSON/MDX/YAML outputs consumed by the docs React components.
The diagram shows the main success path from generation to rendering in the
docs site.
```mermaid
sequenceDiagram
participant Dev as Developer / Docs Build
participant Script as generate-database-docs (lib.py)
participant EngineSpecs as Superset Engine Specs
participant DATABASE_DOCS as DATABASE_DOCS dict
participant Output as Generated JSON/MDX/YAML
participant Docs as Docs React Components
Dev->>Script: Run generation (yarn generate:database-docs / python entry)
Script->>EngineSpecs: Load engine specs & run diagnose() (scores,
capabilities)
Script->>DATABASE_DOCS: Merge spec.metadata with DATABASE_DOCS (fallback)
Script-->>Output: Emit combined docs (databases.json + MDX/YAML per DB)
Docs->>Output: Read generated databases.json / MDX files at build time
Docs-->>Dev: Render searchable index and per-database pages (site)
```
---
*Generated by [CodeAnt AI](https://codeant.ai)*
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
