CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

Add basic usage docs for Build-Toolkit-Docs.ps1 script

Aperta
#282 0 commenti 0 reazioni 1 assegnatario Rivendicata da @Arlodotexe Vedi su GitHub
documentation :page_with_curl: low difficulty powershell
Lingua principale
C#
Stelle
55
Fork
19
Merge medio
40m
PR unite (30g)
1

Descrizione

# Background

Branched from https://github.com/CommunityToolkit/Tooling-Windows-Submodule/issues/280#issuecomment-2776951004

> It only works if you run from the components folder, maybe we should make it more robust so that it can run from the tooling and repo root as well?

The `Build-Toolkit-Docs.ps1` script was designed to be run from the root only. Running without arguments will output to the `./docs` folder in the repo root. From there, they're usually quick-inspected for issues and copied over to the official docs repo, or you can supply a custom `OutputDir` like you did here.

# Problem

The script was used in an unexpected way (not run from root), which led to unnecessary complexity and confusion when it had problems.

# Solution

Basic usage examples should be documented in the powershell script itself. It should be clear that this script, like all our other tooling build scripts, are designed to be run from the root of the repository.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.