Skip to content

Improve documentation generated for options and sub exports - #10640

Merged
timotheeguerin merged 9 commits into
microsoft:mainfrom
timotheeguerin:tspd-improvements
Jun 5, 2026
Merged

Improve documentation generated for options and sub exports#10640
timotheeguerin merged 9 commits into
microsoft:mainfrom
timotheeguerin:tspd-improvements

Conversation

@timotheeguerin

Copy link
Copy Markdown
Member

No description provided.

@timotheeguerin timotheeguerin changed the title Improve documentation generated for options Improve documentation generated for options and sub exports May 11, 2026
@microsoft-github-policy-service microsoft-github-policy-service Bot added meta:website TypeSpec.io updates tspd Issues for the tspd tool emitter:client:js Issue for the JS client emitter: @typespec/http-client-js emitter:json-schema emitter:openapi3 Issues for @typespec/openapi3 emitter labels May 11, 2026
@pkg-pr-new

pkg-pr-new Bot commented May 11, 2026

Copy link
Copy Markdown

Open in StackBlitz

@typespec/http-client-js

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-client-js@10640

@typespec/http-server-csharp

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-server-csharp@10640

@typespec/http-server-js

npm i https://pkg.pr.new/microsoft/typespec/@typespec/http-server-js@10640

@typespec/json-schema

npm i https://pkg.pr.new/microsoft/typespec/@typespec/json-schema@10640

@typespec/openapi3

npm i https://pkg.pr.new/microsoft/typespec/@typespec/openapi3@10640

@typespec/tspd

npm i https://pkg.pr.new/microsoft/typespec/@typespec/tspd@10640

commit: f0b55d0

@github-actions

github-actions Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

All changed packages have been documented.

  • @typespec/tspd
Show changes

@typespec/tspd - feature ✏️

Improve render of complex emitter options

@typespec/tspd - feature ✏️

Render documentation for sub exports

Render documentation for sub exports
Improve the rendering of complex emitter options in documentation.
@azure-sdk

azure-sdk commented May 11, 2026

Copy link
Copy Markdown
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@markcowl markcowl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the new hierarchical view in the docs, just probably should not revers

Comment thread website/src/content/docs/docs/libraries/http/reference/streams/data-types.md Outdated
Comment thread website/src/content/docs/docs/libraries/http/reference/streams/decorators.md Outdated
@timotheeguerin
timotheeguerin added this pull request to the merge queue Jun 5, 2026
Merged via the queue into microsoft:main with commit 4a630c6 Jun 5, 2026
33 checks passed
@timotheeguerin
timotheeguerin deleted the tspd-improvements branch June 5, 2026 21:08
JennyPng pushed a commit to JennyPng/typespec that referenced this pull request Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

emitter:client:js Issue for the JS client emitter: @typespec/http-client-js emitter:json-schema emitter:openapi3 Issues for @typespec/openapi3 emitter meta:website TypeSpec.io updates tspd Issues for the tspd tool

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants