Skip to content

Audit documentation against rushstack implementations; add missing plugin docs, config options, and fix stale references#299

Draft
Copilot wants to merge 9 commits intomainfrom
copilot/review-documentation-accuracy
Draft

Audit documentation against rushstack implementations; add missing plugin docs, config options, and fix stale references#299
Copilot wants to merge 9 commits intomainfrom
copilot/review-documentation-accuracy

Conversation

Copy link

Copilot AI commented Feb 22, 2026

Systematic cross-reference of all documentation sites against microsoft/rushstack and microsoft/tsdoc source code to identify undocumented features, stale URLs, and incorrect defaults.

Stale GitHub branch references (24 files)

  • Updated microsoft/tsdoc and microsoft/rushstack URLs from /master/ to /main/ across api-extractor.com and rushjs.io docs
  • Left faastjs/faast.js URLs on /master/ (verified still correct)

API Extractor: undocumented config options

  • apiReport.tagsToReport — controls which TSDoc tags appear in API report files
  • docModel.releaseTagsToTrim — controls which release tags are excluded from .api.json
  • ae-undocumented message page — diagnostic for missing doc comments (disabled by default)
  • Fixed extractorMessageReporting defaults table — was missing ae-internal-mixed-release-tag, ae-undocumented, ae-wrong-input-file-type

Heft: new plugin and authoring docs

  • Rspack plugin (rspack.md) — @rushstack/heft-rspack-plugin shipped but undocumented
  • Isolated transpile plugin (isolated-transpile.md) — @rushstack/heft-isolated-typescript-transpile-plugin (SWC transpiler) undocumented
  • Authoring plugins guide (advanced/authoring-plugins.md) — covers heft-plugin.json manifest, IHeftTaskPlugin, task hooks, watch mode, CLI parameters, options schema, inter-plugin communication

Rush plugin authoring

  • Added lifecycle hooks reference table — all 8 hooks from RushLifecycleHooks
  • Added RushSession service registration APIs (registerCloudBuildCacheProviderFactory, registerCobuildLockProviderFactory)
  • Removed stale "(experimental)" labels from plugin page titles
// Example from new Rush hooks docs
rushSession.hooks.runPhasedCommand.for('build').tapPromise(
  this.pluginName,
  async (command: IPhasedCommand) => {
    const logger = rushSession.getLogger(this.pluginName);
    logger.terminal.writeLine('The "rush build" command is about to run!');
  }
);

Rush plugin inventory

  • Added rush-buildxl-graph-plugin (published but missing from table)
  • Noted rush-azure-interactive-auth-plugin as secondary plugin in Azure package
  • Marked built-in plugins with "(ships built-in)" — added rush-http-build-cache-plugin to built-in note (was missing alongside S3 and Azure)
  • Added 4 previously undocumented plugins to table: rush-bridge-cache-plugin, rush-http-build-cache-plugin, rush-redis-cobuild-plugin, rush-resolver-cache-plugin

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI changed the title [WIP] Review and update documentation for accuracy and completeness Update outdated GitHub branch references from master to main Feb 22, 2026
Copilot AI requested a review from iclanton February 22, 2026 23:08
Copilot AI changed the title Update outdated GitHub branch references from master to main Add Heft Rspack plugin docs and fix stale branch references Feb 22, 2026
Copilot AI changed the title Add Heft Rspack plugin docs and fix stale branch references Document undocumented API Extractor config options, messages, and fix stale references Feb 22, 2026
Copilot AI changed the title Document undocumented API Extractor config options, messages, and fix stale references Add missing documentation for Heft plugin authoring, API Extractor config options, and fix stale references Feb 22, 2026
Copilot AI changed the title Add missing documentation for Heft plugin authoring, API Extractor config options, and fix stale references Docs: fix stale references, add missing plugin/feature documentation across all sites Feb 22, 2026
Copilot AI changed the title Docs: fix stale references, add missing plugin/feature documentation across all sites Add missing documentation for undocumented plugins, config options, and fix stale references Feb 23, 2026
Copilot AI changed the title Add missing documentation for undocumented plugins, config options, and fix stale references Audit all documentation sites against rushstack implementations; add missing docs and fix stale references Feb 23, 2026
Copilot AI changed the title Audit all documentation sites against rushstack implementations; add missing docs and fix stale references Audit documentation against rushstack implementations; add missing plugin docs, config options, and fix stale references Feb 24, 2026
Copilot AI and others added 3 commits February 24, 2026 00:15
- Update microsoft/tsdoc URLs from /master/ to /main/ across 21 TSDoc tag docs
- Update microsoft/tsdoc URLs in setup/custom_docs.md and tsdoc/declaration_references.md
- Update microsoft/rushstack URLs in rushjs.io publishing.md
- Update prose text "master branch" to "main branch" in generating_docs.md
- Leave faastjs/faast.js URL unchanged as it still uses master branch

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Create new rspack.md plugin doc page with full setup and configuration guide
- Add Rspack plugin to the plugin package index table
- Add Rspack plugin entry to sidebar navigation

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
Copilot AI and others added 6 commits February 24, 2026 00:15
Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Add apiReport.tagsToReport config option documentation
- Add docModel.releaseTagsToTrim config option documentation
- Add ae-undocumented message documentation page
- Add ae-undocumented to sidebar navigation
- Update extractorMessageReporting defaults to include missing entries
  (ae-internal-mixed-release-tag, ae-undocumented, ae-wrong-input-file-type)

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Create comprehensive guide for authoring Heft plugins
- Covers plugin manifest, plugin class implementation, hooks, watch mode,
  plugin options, CLI parameters, and plugin interaction
- Add to Advanced topics section in sidebar navigation

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Remove stale "(experimental)" labels from plugin page titles
- Add lifecycle hooks reference table to creating_plugins.md
- Add service registration API documentation (build cache, cobuild)
- Add code example for tapping specific phased commands
- Update first-party plugins table with 4 missing plugins:
  rush-bridge-cache-plugin, rush-http-build-cache-plugin,
  rush-redis-cobuild-plugin, rush-resolver-cache-plugin

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Create isolated-transpile.md with full plugin documentation
- Add plugin to package_index.md
- Add plugin to sidebar navigation

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
- Add rush-buildxl-graph-plugin to first-party plugins table
- Note rush-azure-interactive-auth-plugin secondary plugin
- Mark rush-http-build-cache-plugin as built-in in descriptions
- Mark rush-amazon-s3 and rush-azure-storage as built-in in descriptions
- Update built-in note to include rush-http-build-cache-plugin

Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
@iclanton iclanton force-pushed the copilot/review-documentation-accuracy branch from dd1b023 to d5765d1 Compare February 24, 2026 08:15
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