Adding API documents which are generated by gen AI#89
Adding API documents which are generated by gen AI#89ToshiakiMasumori wants to merge 1 commit intomainfrom
Conversation
|
Thank you for creating this, @ToshiakiMasumori. As we discussed in chat, this repository has recently introduced a polyrepo (multi-repo) architecture to better support ecosystem growth. At the same time, we keep a monorepo-like structure using The documentation generated by AI is very helpful. It explains each class in detail, including smaller properties, which is especially valuable for developers working on SDK modules. However, it also includes internal classes and interfaces that are intended only for private/internal use. MapConductor is designed for a wide range of users, from beginners to advanced developers. While detailed explanations of internal components are useful for advanced users, they can be overwhelming for beginners. So defining the scope of documentation is important. For general developers, the main need is to understand how to use the MapConductor API. For this, we want to provide more user-friendly documentation (e.g., snippets with screenshots) on the website. On the other hand, developers who want to extend the MapConductor ecosystem will need deeper, more technical documentation. For them, providing detailed Markdown-based documentation per module makes sense, since they will work closely with the core library and individual modules. With that in mind, could you split this large PR into smaller ones and submit them to the corresponding repositories? You can create multiple PRs efficiently using mistletoe. It should be very helpful in this case. Again, thank you very much for your contribution 🙂 |
Adding API document samples which are generated by AI. These are just API docs of which is showing interface and classes in each source file. Generating API documents or sites which is considered user flow is next step and out of scope in this PR.