codeant-ai-for-open-source[bot] commented on PR #36805:
URL: https://github.com/apache/superset/pull/36805#issuecomment-3756265768
## **Sequence Diagram**
The PR makes lib.py the single source of truth for database docs and adds a
generator that collects engine diagnostics, merges metadata (spec.metadata or
DATABASE_DOCS), emits YAML/JSON/MDX files, which the docs frontend consumes to
render the index and per-database pages.
```mermaid
sequenceDiagram
participant DocsBuild as Docs Build / script
participant Lib as superset/db_engine_specs/lib.py
participant EngineSpecs as EngineSpecs Loader
participant FileSystem as Output files (YAML/JSON/MDX)
participant Frontend as Docs React components
DocsBuild->>Lib: run generate_yaml_docs / generator
Lib->>EngineSpecs: load_engine_specs() & diagnose(spec)
EngineSpecs-->>Lib: diagnostics per spec
Lib->>Lib: merge documentation (spec.metadata || DATABASE_DOCS[name])
Lib->>FileSystem: write per-db YAML/JSON/MDX files (databases.json,
individual pages)
FileSystem-->>Frontend: docs build provides generated data
Frontend->>FileSystem: read databases.json
Frontend-->>Frontend: render DatabaseIndex & DatabasePage from generated
data
```
---
*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]
