Document remaining public declarations across the smaller libraries - #11542
Open
timotheeguerin wants to merge 1 commit into
Open
Document remaining public declarations across the smaller libraries#11542timotheeguerin wants to merge 1 commit into
timotheeguerin wants to merge 1 commit into
Conversation
microsoft-github-policy-service
Bot
added
emitter:graphql
timotheeguerin
force-pushed
the
docs/library-docs-rest
branch
from
August 4, 2026 20:07
5df4b0b to
c25b578
Compare
timotheeguerin
force-pushed
the
docs/library-docs-small-libs
branch
from
August 4, 2026 20:07
72c972c to
7f1f47f
Compare
This was referenced Aug 4, 2026
|
You can try these changes here
|
timotheeguerin
marked this pull request as ready for review
August 4, 2026 21:22
timotheeguerin
requested review from
catalinaperalta,
iscai-msft,
markcowl and
xirzec
as code owners
August 4, 2026 21:22
Contributor
|
LGTM for GraphQL |
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
timotheeguerin
enabled auto-merge
August 5, 2026 00:09
…declarations Documents the last undocumented declarations, members and decorator parameters across the smaller libraries. In protobuf, escapes the `@` in the markdown link anchors: the doc parser read `#@TypeSpec.Protobuf.reserve` as a tag, which truncated the published docs mid-link to `[marked reserved](#`. Also wires `lint-typespec-library` into the build of `graphql` and `protobuf`, which ship .tsp but were not linted. Prerequisite for #1229 and #2090.
timotheeguerin
force-pushed
the
docs/library-docs-small-libs
branch
from
August 5, 2026 01:09
0212b44 to
f084f82
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
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.
Clears the last documentation gaps in
protobuf,graphql,eventsandhttp-client, which brings every library in the repo to zero violations.The protobuf part fixes a visible bug on the published docs. Markdown link anchors like
[marked reserved](#@TypeSpec.Protobuf.reserve)have their@read as a doc tag, so the reserve page today renders a bullet that stops mid-link:Percent-encoding the
@keeps the anchor working and restores the sentence.Finally,
graphqlandprotobufship.tspbut never ranlint-typespec-library; they are now wired into their builds like every other library.Prerequisite for #1229 and #2090. The library linter rule that catches this is in #11543, which must merge after this one:
lint-typespec-libraryruns with--warn-as-errorinside every package'sbuild, so the docs have to exist before the rule is turned on.Independent of the other documentation PRs (#11539, #11540, #11541) — they touch disjoint packages and can merge in any order.