codeant-ai-for-open-source[bot] commented on PR #36805:
URL: https://github.com/apache/superset/pull/36805#issuecomment-3766513755
## **Sequence Diagram**
The PR centralizes per-database documentation in each engine spec's
metadata, adds a generator that extracts that metadata into JSON/MDX, and
updates docs React components to consume the generated data to render an index
and individual database pages. The diagram shows the main success path from
metadata → generator → generated site assets → rendered docs.
```mermaid
sequenceDiagram
participant Dev/CI
participant EngineSpecs as "Superset Engine Specs (metadata)"
participant Generator as "Docs Generator (lib.py / mjs)"
participant DocsBuild as "Docs Build (yarn / Docusaurus)"
participant Frontend as "Docs React (DatabaseIndex / DatabasePage)"
participant User
Dev/CI->>EngineSpecs: Add/maintain metadata attribute in each EngineSpec
DocsBuild->>Generator: Run generator (AST/parsing) to extract metadata
Generator-->>DocsBuild: Emit databases.json / per-db MDX pages
DocsBuild->>Frontend: Bundle generated JSON/MDX into site assets
User->>Frontend: Request docs pages
Frontend-->>User: Render searchable index + individual DB pages using
metadata
```
---
*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]
