AvaloniaUI / avalonia-docs

https://docs.avaloniaui.net/docs/welcome
60 stars 193 forks source link

Community feedback request regarding docs discoverability #420

Open stevemonaco opened 6 months ago

stevemonaco commented 6 months ago

Looking for feedback from the community pertaining to their experience with finding relevant docs, assuming they exist.

There are a few ways to address discoverability that I'm aware of:

An example of a roadmap would be similar to this JavaScript roadmap to give a high-level overview of what's available in XAML and linked to existing relevant information in docs. I don't know how to create one though without building it from scratch. Controls would have their own roadmap or at least a centralized table that can be sorted alphabetically and categorically with use cases.

Fxplorer commented 5 months ago

Ok, the JavaScript roadmap is very cool! Coming in cold with most things regarding actual application building, I have been very confused in a lot of things, including exactly how Avalonia actually works. I know there is the “how it works” page on the main site and the “Architecture Overview” diagram but it is still not clear. I watched the 2023 (and 2022 actually) .Net Conf video that had a graphic that compared Avalonia to Maui. That block diagram was actually helpful. I have come to realize there are ‘levels’ of information and reference needed. Maybe making conscious efforts to section off these levels would be helpful. There is the “I want to build an app path” so I just need to know what blocks do I need to do that. There is the “I want to add functionality to Avalonia path” where I need references to how the pieces fit together etc. Not sure how valuable this feedback is. I am struggling to devise a plan and a solution for things I want to build myself regarding docs and information transfer.