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

All WinUI 3 / WASDK api reference docs are missing / broken #119

Closed
kmgallahan opened this issue May 28, 2022 · 11 comments
Closed

All WinUI 3 / WASDK api reference docs are missing / broken #119

kmgallahan opened this issue May 28, 2022 · 11 comments
Labels
Pri3 Topic is in the bottom 50% of page views for the repo or was not created via Feedback control.

Comments

@kmgallahan
Copy link
Contributor

kmgallahan commented May 28, 2022

As per the title, try visiting various api docs:

https://docs.microsoft.com/en-us/windows/winui/api/

Selecting WinUI 3 from the left drop down doesn't work.

Trying to open WinUI 3 doc links from Visual Studio always fails.

Screenshot 2022-05-28 110050

@PRMerger7 PRMerger7 added the Pri3 Topic is in the bottom 50% of page views for the repo or was not created via Feedback control. label May 28, 2022
@kmgallahan kmgallahan changed the title WinUI 3 / WASDK api reference docs are missing / broken All WinUI 3 / WASDK api reference docs are missing / broken May 28, 2022
@asklar
Copy link

asklar commented May 31, 2022

@GrantMeStrength @stevewhims fyi

@Karl-Bridge-Microsoft
Copy link
Collaborator

Hi @kmgallahan - actively working on this. Some of this should be sorting itself out as related PRs are merged and search engines update.

@MarkBrainfire
Copy link

MarkBrainfire commented Jun 3, 2022

Wow! The ENTIRE DOCUMENTATION FOR WINUI 3 IS BROKEN and no one is fixing this? I raised this issue a week ago. Who sets the priorities here? WinUI 3 is the future for Windows and cross platform development (via UNO and MAUI) and yet Microsoft tolerates an entire week going by where no one can access any documentation?

It's funny ... my mental model is that Microsoft employs large teams working on its key technologies. In my mind, WinUI 3 is kind of a big deal. Am I wrong? Are there just a couple of people working on it? When someone breaks the entire online documentation for Microsoft's MAIN FUTURE TECHNOLOGY is no one held responsible?

I'm basing my entire future on WinUI 3. Am I wrong to do so? Is Microsoft running things this casually?

Hello?????

@kmgallahan
Copy link
Contributor Author

@MarkBrainfire It appears that everything was moved here, but the migration wasn't handled very well (and probably isn't complete regarding all references & links).

@marb2000
Copy link

marb2000 commented Jun 3, 2022

Thank you @kmgallahan and @MarkBrainfire for reporting this. Our doc team is working on fixing the broken links. We did massive changes and we are trying to fix them ASAP.
Also, apologies for these issues.

@MarkBrainfire
Copy link

@marb2000 THANK YOU! "Massive changes" sounds intriguing. Great knowing that you're working on this. No apologies needed. I remain enthusiastic about the potential of C# and WinUI 3.

@michael-hawker
Copy link

@marb2000 is there an ETA for this? Is there a reason this has the Pri3 label? That seems incorrect?

The WinUI 2 docs used to be easily switched to the WinUI 3 ones to look up/compare. But now the link just lands you on the WinAppSDK landing page which isn't helpful.

@kmgallahan
Copy link
Contributor Author

kmgallahan commented Jun 16, 2022

@michael-hawker Pri3 appears to be applied to any issue not created through the Docs Feedback mechanism.

I also don't think the API docs should reference and cross-link to each other since the WinUI 2 vs 3 naming is not optimal (they aren't really version numbers of the same product).

The naming "WinUI for UWP" and "WinUI for WASDK" is less confusing, and appears to now be present on the WinUI 2 pages:

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

While the WinUI for WASDK pages don't link back to WinUI 2 - which I like as development of it and UWP are basically dead at this point, so no need to confuse newcomers.

@Karl-Bridge-Microsoft
Copy link
Collaborator

Hi @kmgallahan, @MarkBrainfire, @michael-hawker - There were a lot of moving parts to this restructuring and because of much duplication of APIs between UWP, WinUI2, WinUI in the Windows App SDK, global search and replaces were problematic and had the potential to introduce many more issues that would be difficult to recover cleanly from. I decided to err on the side of caution and make the link updates as solid as possible. Our build tools were also an issue over the last week or so, which slowed things down a bit.

I think this particular issue has been resolved (the version drop down showing WinUI 3 and redirecting to WinUI 2 topics). The cross links from across related doc repos have also been addressed for the most part. However, I expect there might still be some glitches here and there that I hope our broken link reports will help me identify and fix over time.

If you still encounter cross link or redirection problems, please open a new Issue and I'll try to address ASAP.

@michael-hawker
Copy link

michael-hawker commented Jun 16, 2022

@Karl-Bridge-Microsoft I agree this issue that was more geared towards the drop-down is resolved. But I still see issues overall with how things are linked together. Would you like me to open a new issue to explain? NavigationView is a great example for this.

I also don't think the API docs should reference and cross-link to each other since the WinUI 2 vs 3 naming is not optimal (they aren't really version numbers of the same product).

The naming "WinUI for UWP" and "WinUI for WASDK" is less confusing, and appears to now be present on the WinUI 2 pages:

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

While the WinUI for WASDK pages don't link back to WinUI 2 - which I like as development of it and UWP are basically dead at this point, so no need to confuse newcomers.

@kmgallahan I can get behind having the WinAppSDK control pages not linking backwards, but having the UWP ones point to WinUI 2, and the WinUI 2 ones point to WinAppSDK is really helpful. As a library author or someone needing to port a UWP application to the WinAppSDK, there can be differences in the APIs between them sometimes, so being able to quickly go from my current doc set to the new version of it without having to do yet another search is important. This flow worked rather well in the old setup.

@Karl-Bridge-Microsoft
Copy link
Collaborator

@michael-hawker - A new Issue would be better for tracking. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Pri3 Topic is in the bottom 50% of page views for the repo or was not created via Feedback control.
Projects
None yet
Development

No branches or pull requests

7 participants