CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

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

Ouverte
#282 0 commentaires 0 réactions 1 personne assignée Voir sur GitHub

@Arlodotexe y travaille déjà.

Depuis le 6/4/2025.

documentation :page_with_curl: low difficulty powershell
Langage dominant
C#
Étoiles
56
Forks
19
Merge moyen
40 min
PR mergées (30 j)
1

Description

# 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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.