Best practices for AI/MCP code creator doc page and docs navigation update possible? #10904
Replies: 3 comments
-
Right now we are working towards replacing all legacy controls with their modernized equivalents. In Summer we plan to release v5 with all legacy stuff dropped completely and after that we wanted to update our documentation. We will keep the points you raised in mind when doing so, thank you for bringing this up 👍 |
Beta Was this translation helpful? Give feedback.
-
Im very interested on this also, glad to help |
Beta Was this translation helpful? Give feedback.
-
@Donnerstagnacht hi! Do you want to improve AI support section and to add "AI prompts" subsection with instructions as you describe here? #11053 (comment) |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
With the latest and nice (!) import/textfield changes and the progress in AI code generation, I wanted to ask if it would be possible to create a best practices page in the documentation section (for example like supabase?
For example, I liked your medium article and probably this one could be refactored into a best practice/ai prompt style with a bit more focus on current dos and don't (as angular or supabase do it).
I personally feel that most AI models seem to have problems generating "taiga-code" correctly with the recent changes. For example, I am often replacing inputs with textfields and import statements. AI powered agents (vs-code, cursor...) also seem to have issues with reading your current doc.
Second, with recent changes like cards/islands and input/textfield the component section in the documentation misses a bit organization in my opinion. As an idea, it could be split in two navigations - one purely alphabetical reference (including layout and so on) (as angular-material and one by function but a bit more granular (as prime with (forms/button/data/panel/overlay/menu/chart/media/misc) or a categorization in latest/legacy. In that case, for example, island and cards could go into the layout section (right now island is in the component section and cards in the layout section), representing a latest and a legacy option for a common layout solution. The layout section then displays a user all current taiga features for layouts across versions. Textarea, on the other hand, could be its own nav item (and not a subitem of legacy inputs) and part of the forms section together with textfields and inputs.
In that case, a user could browse your current good documentation and stackblitz examples by alphabetical reference, ui-function and best practices/ai prompts.
I personally could imagine this could make taiga even more attractive on a productivity level since AI tooling/code generation will become more and more important in the future. Second, it keeps your docs organized as you publish new features.
Thanks for your great open source work!
Beta Was this translation helpful? Give feedback.
All reactions