New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #2232

Closed

mikekistler opened this issue Jul 31, 2023 · 0 comments · Fixed by #2951

Labels

Milestone

Member

mikekistler commented Jul 31, 2023

Here are a few areas where organization of content of the public documentation could be improved:

Data types should be in alpha order (ApiKeyLocation, AuthType, and OAuth2FlowType at the bottom of the list are out of order)
- https://microsoft.github.io/typespec/next/standard-library/http/reference/data-types
Data types referenced from decorators should be linked, e.g. QueryOptions in
- https://microsoft.github.io/typespec/next/standard-library/http/reference/decorators#@TypeSpec.Http.query
Doc for QueryOptions does not describe its properties
- https://microsoft.github.io/typespec/next/standard-library/http/reference/data-types#TypeSpec.Http.QueryOptions

The text was updated successfully, but these errors were encountered:

microsoft-github-policy-service bot added the needs-area label

markcowl added this to the Backlog milestone

timotheeguerin mentioned this issue

Improved ref docs for model #2951

Merged

timotheeguerin closed this as completed in

02ed01e

timotheeguerin closed this as completed in #2951

markcowl pushed a commit to markcowl/cadl that referenced this issue


          Improved ref docs for model (microsoft#2951)

87e2559

fix Azure/typespec-azure-pr#3861
fix microsoft#2232
Generate docs for model properties and reference models within the same
package
<img width="1213" alt="image"
src="https://github.com/microsoft/typespec/assets/1031227/ae7eccd0-97d8-401e-b07f-3375c7b41446">

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment