Add missing documentation for plugins, config options, and fix stale references#299
Open
Add missing documentation for plugins, config options, and fix stale references#299
Conversation
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
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
iclanton
force-pushed
the
copilot/review-documentation-accuracy
branch
from
dd1b023 to
d5765d1
Compare
Copilot
AI
changed the title
Audit documentation against rushstack implementations; add missing plugin docs, config options, and fix stale references
Add missing documentation for plugins, config options, and fix stale references
Mar 1, 2026
- 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>
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>
The heft.rushstack.io build was failing because the zh-cn locale could not resolve markdown links in three new pages that lacked corresponding translation stubs: - authoring-plugins.md - isolated-transpile.md - rspack.md Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
iclanton
force-pushed
the
copilot/review-documentation-accuracy
branch
from
bf542e1 to
e5da44b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Systematic audit of all documentation sites against
microsoft/rushstacksource code. Found undocumented plugins, missing config options, stale branch URLs, and incomplete authoring guides.Stale GitHub branch references (24 files)
microsoft/tsdocandmicrosoft/rushstackURLs from/master/to/main/New Heft plugin documentation
@rushstack/heft-rspack-pluginwas shipped but undocumented@rushstack/heft-isolated-typescript-transpile-plugin(SWC transpiler) was undocumentedheft-plugin.jsonmanifest,IHeftTaskPlugin, task hooks, watch mode, CLI parameters, options schema, inter-plugin communicationAPI Extractor: undocumented config options
apiReport.tagsToReport,docModel.releaseTagsToTrimae-undocumentedmessage page + sidebar entryextractorMessageReportingdefaults table (missingae-internal-mixed-release-tag,ae-undocumented,ae-wrong-input-file-type)Rush plugin authoring
RushLifecycleHooks)RushSessionservice registration APIs (registerCloudBuildCacheProviderFactory,registerCobuildLockProviderFactory)Rush plugin inventory
rush-buildxl-graph-pluginto first-party tablerush-azure-interactive-auth-pluginas secondary plugin in Azure packagerush-http-build-cache-pluginto the built-in note (was missing)CI fix
The heft.rushstack.io build was failing because new doc pages lacked zh-cn locale stubs, causing Docusaurus markdown link resolution errors during the zh-cn build:
Fixed by adding translation stub copies for
authoring-plugins.md,isolated-transpile.md, andrspack.md.🔒 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.