Skip to content

Comments

Add documentation missing for linting rules#3963

Open
timotheeguerin wants to merge 8 commits intoAzure:mainfrom
timotheeguerin:data-plane-linter-rules-docs
Open

Add documentation missing for linting rules#3963
timotheeguerin wants to merge 8 commits intoAzure:mainfrom
timotheeguerin:data-plane-linter-rules-docs

Conversation

@timotheeguerin
Copy link
Member

Generated documentation for the linting rules with copilot cli.
Seems to have done a pretty good job. I don't know fully the purpose of all of them so need a 2nd set of eyes

@microsoft-github-policy-service microsoft-github-policy-service bot added the lib:azure-core Issues for @azure-tools/typespec-azure-core library label Feb 23, 2026
@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 23, 2026

Open in StackBlitz

npm i https://pkg.pr.new/Azure/typespec-azure/@azure-tools/typespec-azure-core@3963

commit: f85239a

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 23, 2026

All changed packages have been documented.

  • @azure-tools/typespec-azure-core
Show changes

@azure-tools/typespec-azure-core - internal ✏️

Add documentation missing for linting rules

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 23, 2026

You can try these changes here

🛝 Playground 🌐 Website

@timotheeguerin timotheeguerin marked this pull request as ready for review February 23, 2026 19:31
@@ -0,0 +1,45 @@
---
title: "byos"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to match the last segment of the rule id? If not, this should be Bring your own Storage

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah that is the pattern we have, also that is what shows up in the sidebar and want that to match so you can easily find the rule

@timotheeguerin timotheeguerin added the int:azure-specs Run integration tests against azure-rest-api-specs label Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

int:azure-specs Run integration tests against azure-rest-api-specs lib:azure-core Issues for @azure-tools/typespec-azure-core library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants