codeant-ai-for-open-source[bot] commented on PR #36805:
URL: https://github.com/apache/superset/pull/36805#issuecomment-3757600915
## **Sequence Diagram**
The PR centralizes per-database documentation into each engine spec's
metadata, adds a generator that extracts/merges those metadata entries into a
JSON/YAML docs artifact, and updates React components to consume that artifact
to render the docs. The diagram shows the main success path from engine specs →
docs generator → generated artifact → frontend rendering.
```mermaid
sequenceDiagram
participant CI as CI / Dev
participant Generator as docs generator (lib.py / mjs)
participant EngineSpecs as Engine Spec classes (metadata)
participant Artifact as databases.json / YAML files
participant Frontend as React docs components
CI->>Generator: Run docs generation (generate_yaml_docs / mjs)
Generator->>EngineSpecs: Load engine specs (load_engine_specs or AST)
and read metadata
EngineSpecs-->>Generator: metadata (per-spec DBEngineSpec.metadata)
Generator->>Generator: diagnose & merge runtime diagnostics with metadata
Generator->>Artifact: Write combined JSON/YAML docs artifact
Frontend->>Artifact: Load databases.json at build/runtime
Artifact-->>Frontend: Databases data (documentation, scores, compatible
DBs)
Frontend->>User: Render DatabaseIndex / DatabasePage from artifact
```
---
*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]
