uno
uno copied to clipboard
Feat(toc checker) improve toc checker script, add pester tests and add docs
GitHub Issue (If applicable): closes #
Seperated from: #19722
PR Type
What kind of change does this PR introduce?
- Feature
- Documentation content changes
- Tests (non runtime, toc checker)
What is the current behavior?
Current docfx guide is outdated and telling to use docfx.console which has been depreciated see more Information to this here: https://github.com/dotnet/docfx/issues/9100 Link to the Documentation page The Uno.Extensions Repository is already having the new commands in its Readme.md
Secondary, the check_toc.ps1 does list almoast every href as not linked to a file, because it does not recognize the xref link declaration
Third page is way smaller changes:
- The Getting-started did not at all mention the need to install dotnet before Uno.Check (that is only told on the actual Uno.Check Page) so thats more a reason of completeness of the Quick Start.
- I did frequently notice Beginners ask about Trouble-Shooting Uno.Check and since we did already seperate its Pages (much better from my point of view!) there has been those links been missing.
What is the new behavior?
-
Updated the docfx commands
- I did left there some commented text, which needs to be checked if the new one is enough. Problem with that is, I do not understand the UWPSyncGenerator so deeply to decide this. Currently, those comments do stretch the md line distance a bit (vs 2022 preview) althought its hidden.
-
Added a detailed guide to the usage of check_toc.ps1 along with adding the capability of recognizing and comparing the xref -> uids
- By this it also did uncover the features/windows-xaml-ui-xbind link beeing broken, I did already wonder last days. Was unable to navigate to this page in the docs.
- Second link it did uncover is the only url link in toc and to me it looks okay, but maybe someone would like to check this...
- Another Link I do not know if the url is correct is the now nested Uno.Check Pages I tryed to link from the Getting-Started. The old one does have a different signature...
- Because of that new capability of the script, I added a -Verbose Flag for it, so in case of problems, there would be informations available, till which point it came.
- Help needed with the Link to the gif I added to this for showing a workaround for those who might not know these steps until this point, to find not inluded files in vs 2022. I used the docfx documentation way for Image, but its showing only a broken image symbol...
PR Checklist
Please check if your PR fulfills the following requirements:
- [x] Docs have been added/updated which fit documentation template (for bug fixes / features)
- [ ] Unit Tests and/or UI Tests for the changes have been added (for bug fixes / features) (if applicable)
- [x] Pester Tests for contributing relevant test
- [ ] Validated PR
Screenshots Compare Test Runresults. => not all passing, needs help on Import test please. Get-MarkdownHeaders passes, will share results in to be added comments below - [x] Contains NO breaking changes
- [ ] Associated with an issue (GitHub or internal) and uses the automatic close keywords.
- [x] Commits must be following the Conventional Commits specification.
Other information
- Needs help on above mentioned Pester test script
- @agneszitte FYI: PR is split from #19722
Internal Issue (If applicable):
🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-19981/index.html
🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-19981/docs/index.html
@jeromelaban as the test scripts here are needing some assistance from someone who might see my mistake, could you consider copilot to review?
I tryed to fix them in vscode and vs2022 with Copilot and openAI gpt, but not coming to a solution so the test passes. Added detailed information about the appearing issues its having to the initial PR in the past.
failing state of the tests where I would need some help is on #19722 for more information
🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-19981/docs/index.html
🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-19981/docs/index.html
@booskander here 😔