codeant-ai-for-open-source[bot] commented on PR #36805:
URL: https://github.com/apache/superset/pull/36805#issuecomment-3764620304
## **Sequence Diagram**
This PR centralizes database documentation in each engine spec's metadata,
adds a generator that extracts metadata + diagnostics to produce JSON/YAML/MDX,
and updates the docs React components to consume the generated data. The
diagram shows the main success path from generator to rendered docs.
```mermaid
sequenceDiagram
participant CI/Dev as CI / Developer
participant Generator as generate-database-docs (lib.generate_yaml_docs)
participant EngineSpecs as superset/db_engine_specs/*.py
participant Diagnostics as diagnose()
participant DocsData as docs/data/databases.json / MDX/YAML
participant DocsUI as React Docs (DatabaseIndex / DatabasePage)
CI/Dev->>Generator: Run generator script in CI or locally
Generator->>EngineSpecs: Load engine specs (AST or import)
EngineSpecs-->>Generator: Provide metadata attribute for each spec
Generator->>Diagnostics: Run diagnostics for each spec (scores,
time_grains)
Diagnostics-->>Generator: Diagnostic results
Generator->>DocsData: Emit JSON/YAML/MDX pages (per-db + index)
DocsUI->>DocsData: Read generated databases.json / MDX at build/runtime
DocsData-->>DocsUI: Supply docs content (drivers, conn strings,
compatible DBs)
DocsUI-->>CI/Dev: Render searchable overview and individual DB pages
```
---
*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]
