[rush reporter][R10] Publish opt-in reporter docs and demo guide

Open
#5,983 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
nodejs, typescript
Domain
build-system, cli, documentation

Research direction

Start with the demo milestone and the blockers #5978 and #5979, then use the direct rush build demo as the entry point. Document the listed reporter flags, repository opt-in, RUSH_REPORTER, TTY/CI behavior, output contracts, rollback, and cross-version behavior. Done means a clean-checkout demo is reproducible and the migration material is linked from package/API docs and release notes.

Written by the indexing model from the issue text.

Description

enhancement

Parent: #5858

Blocked by: #5978; bootstrap-specific documentation also depends on #5979

Goal

Make the opt-in reporter demo reproducible and document the pre-major safety model.

Scope

  • Document --reporter, --output, --log-level, verbosity aliases, the repository experiment, and RUSH_REPORTER.
  • Publish a direct rush build demo showing legacy output, compact default output, AI remediation output, and the full-detail log.
  • Explain TTY/CI behavior, stdout/stderr contracts, color handling, privacy boundaries, and how to disable the feature.
  • Add bootstrap and cross-version behavior after R6 lands.
  • Link the migration material from the package/API docs and release notes.

Acceptance criteria

  • A maintainer can reproduce the demo from a clean checkout using documented commands.
  • The docs clearly distinguish per-invocation opt-in, repository opt-in, future auto-selection, and Rush 6 defaults.
  • Emergency rollback and full-log discovery are prominent.
  • Examples cover interactive, CI, and agent contexts without promising pre-gate auto-selection.

DAG

Runs after the demo milestone and contributes to the Rush 6 migration material.

Part of #5858.

Dominant language
TypeScript
Stars
6.5k
Forks
708
Avg merge
5d 19h
Merged PRs (30d)
48

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/rushstack

All issues in microsoft/rushstack

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.