CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

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

Open
#282 0 comments 0 reactions 1 assignee Claimed by @Arlodotexe View on GitHub
documentation :page_with_curl: low difficulty powershell
Dominant language
C#
Stars
55
Forks
19
Avg merge
40m
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.