Repository navigation
docs: improve gRPC schema table readability - #1842
Merged
Merged
Conversation
samuv
marked this pull request as ready for review
September 24, 2026 09:14
samuv
force-pushed
the
t3code/improve-docs-table-readability
branch
from
September 24, 2026 09:24
065d5ac to
a0d0dff
Compare
samuv
force-pushed
the
t3code/improve-docs-table-readability
branch
from
September 24, 2026 10:51
a0d0dff to
b8cd24e
Compare
samuv
force-pushed
the
t3code/improve-docs-table-readability
branch
from
September 24, 2026 13:49
0ff9554 to
c54d315
Compare
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Samuele Verzi <samu@stacklok.com>
Co-Authored-By: Codex <codex@openai.com> Signed-off-by: Samuele Verzi <samu@stacklok.com>
Signed-off-by: Samuele Verzi <samu@stacklok.com> Co-Authored-By: Codex <codex@openai.com>
Signed-off-by: Samuele Verzi <samu@stacklok.com> Co-Authored-By: Codex <codex@openai.com>
Signed-off-by: Samuele Verzi <samu@stacklok.com> Co-Authored-By: Codex <codex@openai.com>
samuv
force-pushed
the
t3code/improve-docs-table-readability
branch
from
September 25, 2026 10:24
bac89a3 to
c88227b
Compare
peppescg
approved these changes
Sep 25, 2026
peppescg
left a comment
Contributor
There was a problem hiding this comment.
Approving: none of the points below are blocking.
The source change is in scripts/grpc-schema.md.tmpl, and the page was regenerated from it rather than edited by hand. Descriptions still pass through table-safe, which HTML-escapes them, so no markup can reach the MDX JSX. The toggle's ARIA wiring is correct (aria-controls, aria-expanded, and a per-RPC label). The page also degrades well without JavaScript: the full text stays visible.
Optional follow-ups
- Descriptions are duplicated in the DOM.
GrpcDescriptionrenders each description twice: once in the hidden measure span and once in the visible span. Browser find-in-page skipsvisibility:hiddentext, but@easyops-cn/docusaurus-search-localindexes the built HTML. It probably indexes all ~70 descriptions twice, which would give doubled search hits (not verified on a built site). Measuring the visible span directly, with the clamp temporarily removed, would avoid the second copy. - Layout shifts on hydration.
overflowsstartsfalse, so the static HTML shows full descriptions and they collapse after mount. On a page of about 4.3k lines, the content shifts visibly on load. This is an acceptable trade-off for no-JS readability; just noting it. - Table semantics on mobile. At 640 px and below,
display: block/gridontable,trandtddrops the table roles in several browsers. Thegrpc-mobile-labelspans mostly compensate. Explicitrole="table"/role="row"attributes are optional. - Generated-file conflicts. #1891 and #1909 also touch
grpc-schema.md. Whichever PR lands later only needs to runtask docs:grpc-refagain.
Merged
2 tasks
jbeda
added a commit
that referenced
this pull request
Sep 25, 2026
…mit-coauthor-guidance * origin/main: (32 commits) docs: plan optional native Kubernetes execution provider (#1579) feat(mecatui): restore session status metrics (#1891) docs(plan): bound agent inventory viewport (#1946) docs: include user-docs in matlatl and use local documentation links (#1934) feat(mecatui): bound sessions inventory (#1944) feat(studio): show session delegation activity (#1907) docs(plan): define Studio session activity (#1885) Release TypeScript SDK v0.4.0 (#1940) Release v0.0.41 (#1941) docs(mecatui): plan bounded sessions inventory (#1906) feat(studio): add exact plan control and authorization review prerequisite (#1909) test(app): eliminate real ToolHive probe deadline wait (#1937) docs(plan): define Studio chat approvals and exact plan control (#1888) test(sdk): enforce SDK/TUI high-level parity (#1471) (#1917) docs(plan): propose SDK high-level parity coverage (#1471) (#1916) docs: improve gRPC schema table readability (#1842) test(app): eliminate real waits in durable learning tests (#1933) feat(studio): align chat transcript and composer (#1886) docs(plan): define Studio chat transcript and composer (#1880) feat: correlate provider requests with the root session (#1883) ...
7 tasks
This branch was successfully deployed
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
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.
Summary
Reader need and owner
Readers looking up gRPC method signatures and descriptions use
user-docs/reference/grpc-schema.md. The source for the service tables isscripts/grpc-schema.md.tmpl.Verification
task docs:grpc-refregenerated the page from the template.task site:buildpassed.