michael-s-molina commented on PR #35217: URL: https://github.com/apache/superset/pull/35217#issuecomment-3373286089
Great work @rusackas! This establishes a solid foundation for us to iteratively build the developer docs. @villebro Could you please review the `Example: Hello World` section given that you'll use it for the OSA Con 2025 presentation? I'll focus on the general structure: 1. We could rename `Developer Portal Overview` just to `Overview`. I would also instead of indexing all possible sub-pages of each category (`Extensions`, `Testing`, `Contributing`) just explain each category and what type of documentation users will find in each section. Then, in each category we would have an `Overview` page with indexes for each sub-page. 2. `Contributing to Superset` or just `Contributing` (simpler) would be the first category after `Overview` as it lays the foundation for contributions. 3. I think it would be nice to have an `Overview` page for extensions. We could use the Motivation sections of [SIP-151](https://github.com/apache/superset/issues/31932) and [SIP-177](https://github.com/apache/superset/issues/34162) as source for the content. 4. I would merge the `Architecture Principles` and `High-Level Architecture` as sub-sections of a single page called `Architecture`. 5. I wonder if the `Example: Hello World` section should be renamed to `Quick Start` and moved right below `Overview`. Similar to how [VSCode organized their docs](https://code.visualstudio.com/api/get-started/your-first-extension) (but without a sub-section). <img width="190" height="470" alt="Screenshot 2025-10-06 at 15 17 59" src="https://github.com/user-attachments/assets/7e4148e2-a384-48a6-82e8-35ef5dd01236"; /> -- 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]
