Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Community feedback request regarding docs discoverability #420

Open
stevemonaco opened this issue Mar 21, 2024 · 1 comment
Open

Community feedback request regarding docs discoverability #420

stevemonaco opened this issue Mar 21, 2024 · 1 comment

Comments

@stevemonaco
Copy link
Collaborator

stevemonaco commented Mar 21, 2024

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:

  • Sidebar Topic Organization - Requires significant time to reorganize. Breaks external links and SEO.
  • Search - We have in-docs search. It's sometimes helpful. Automated.
  • Tags - We don't use these, but Docusaurus has support. Each page lists tags that lead to an aggregate page containing pages with the same tag. Assigning tags is manual, tag pages are automated. Need to be careful to not overtag loosely related pages.
  • "Meta pages" - We don't use these effectively. Meta pages aggregate links to related pages into a single, dense page. Tag pages, roadmaps, and control listings are examples.

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.

@stevemonaco stevemonaco pinned this issue Mar 21, 2024
@Fxplorer
Copy link
Contributor

Fxplorer commented Apr 3, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants