fix(http): restore historical linter rule reference doc url#11320
Merged
Conversation
The tspd change that auto-generates one reference page per linter rule (#11221) moved the http rule page from `libraries/http/rules/<name>` to `libraries/http/reference/rules/<name>`, which broke the existing rule documentation url (the rule's own `url` field, external links, and diagnostic "see documentation" links all point at the historical location). Use the `--rules-dir ../rules` option (added in #11316) in http's `regen-docs` so the rule pages are written back to `libraries/http/rules/<name>`, restoring the original url. Regenerate the docs and re-enable the sidebar Rules group. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: de8537de-5e61-4a0d-b2de-59ec12c15dc4
tadelesh
requested review from
bterlson,
catalinaperalta,
iscai-msft,
markcowl,
timotheeguerin and
witemple-msft
as code owners
July 21, 2026 00:12
microsoft-github-policy-service
Bot
added
lib:http
meta:website
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
timotheeguerin
approved these changes
Jul 21, 2026
|
You can try these changes here
|
tadelesh
enabled auto-merge
July 21, 2026 00:28
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Jul 21, 2026
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
2 participants
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.
Problem
The tspd change that auto-generates one reference page per linter rule (#11221) moved the
@typespec/httplinter rule page from its historical location:https://typespec.io/docs/libraries/http/rules/op-reference-container-routehttps://typespec.io/docs/libraries/http/reference/rules/op-reference-container-routeThis is a breaking change to the public documentation URL. The rule's own
urlfield, external links, and the diagnostic "see documentation" link all still point at the historicallibraries/http/rules/<name>location, which now 404s.Fix
Use the
--rules-dir ../rulesoption (added in #11316) in http'sregen-docsscript so the per-rule reference pages are written back tolibraries/http/rules/<name>, restoring the original URL.packages/http/package.json— add--rules-dir ../rulestoregen-docs.libraries/http/rules/op-reference-container-route.md(100% rename) andlinter.mdlinks back to../rules/....current-sidebar.ts— re-enable the http "Rules" sidebar group (hasLinterRules: true), which autogenerates fromlibraries/http/rules.@typespec/httpis the only library in this repo that ships linter rules, so no other library is affected.Validation
regen-docsis stable (running it twice produces no diff).libraries/http/rules/op-reference-container-routematches the rule's hardcodedurlagain.chronus verifypasses.