Skip to content

docs(Configuration): adding visual content and improve structure for brevity #362

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

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

DevTKSS
Copy link
Contributor

@DevTKSS DevTKSS commented Apr 8, 2025

Visual Content to simplify understanding possibilities (skip and list of skips can be tricky)
added information about help argument is available
Seperated CI topic to own area

Done:

  • Will check if toc.yml needs future adjustments
  • Check added files to be linked properly
  • Enhanced Readme.md file so it can also be used as Intro

TODO:

  • Build has to show if the link to UnoCheck.Intro is successfull this way

Help needed:

  • Structure inside of Tabs should be unified similar to api docs with syntax, explaination incl. sample and to be checked synonym arguments, but this could also be done in syntax area before.

DevTKSS added 3 commits April 7, 2025 21:39
Latest dotnet will guide user to right direction
xref applying like main uno repo
added include by xref for GettingHelp with TroubleShooting sourced from Main Repository includes
@DevTKSS
Copy link
Contributor Author

DevTKSS commented Apr 30, 2025

@agneszitte FYI: all checks passed here :)


### `--target` Choose target platforms
# [**target platforms**](#tab/arg-target)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we instead of the descriptions use the name of the parameter instead everywhere? In that case [-t|--target]. Becuase to users that not familiar with these parameters just "Target platforms" or "Continuous Integration" won't tell anything. Lets make the parameter name the header of the tab and the context of the tab will describe what it does

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will check on them and then add the screenshots taken here. but for those with the --version and --help I only get them with localized description, maybe that will then need someone with en-us localization to adjust this parts

Comment on lines +15 to +17
[!INCLUDES [uno-check-help](../includes/uno-check-help.md)]

The following command line arguments can be used to customize the tool's behavior.
[!INCLUDES [Uno-Check-Windows-Elevation](../includes/uno-check-help.md)]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why we need these?
image
For me it doesen't render and also it references the same link

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Takoooooo are those the build or vs code preview? seems like no extension is capable of rendering includes at this moment. try it with local build instead. I set up for myself a docfx with modern template (PR at main repo thats needs someone fix the last powershell location issue to hopefully than enable also non uno team contributors use the import external docs script to get their externals if some to check them) to validate those kind of things locally. as you will know, thats not optimal as workaround but I dont know any other way to get there realistically otherwise

@DevTKSS
Copy link
Contributor Author

DevTKSS commented May 6, 2025

@Takoooooo added the local images I meant already now, maybe you want to take a look and replace if yours is localized correctly so i could link them then later on

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

Successfully merging this pull request may close these issues.

2 participants