Skip to content

docs(site): wrap long table tokens and list host capabilities by group - #490

Merged
ScriptedAlchemy merged 1 commit into
mainfrom
docs/site-wide-tables
Sep 4, 2026
Merged

docs(site): wrap long table tokens and list host capabilities by group#490
ScriptedAlchemy merged 1 commit into
mainfrom
docs/site-wide-tables

Conversation

@ScriptedAlchemy

Copy link
Copy Markdown
Owner

Follow-up to the desktop screenshot audit of every docsite page (1,534 routes at 1440×900). The only layout defects were tables scrolling sideways: the host capability matrix up to 709px, the event matrix 152px, and small (~50–70px) overflows on project structure and runtime environment.

Root cause. Rspress tables use table-layout: auto, so one unbreakable token — a stringified JSON object in a Detail cell, a dotted capability key, a URL — widens its column to the token's full length. overflow-wrap: anywhere was tried first and rejected: it shrinks the columns instead, breaking short identifiers mid-word (TeammateIdl|e) once five columns share the content width.

Changes

  • website/plugins/generated-reference.ts: the per-host "Plugin components" tables (154 rows for Claude) become Rspack-style reference sections — #### per top-level group (agents, distributionPolicy, …) with one list entry per capability (`path` **state** — detail). Anchors and the on-page outline replace a three-column grid. Object-valued details render as one key.member: value line each.
  • website/plugins/rehype-table-cell-breaks.ts (new, wired via markdown.rehypePlugins): inserts <wbr> into code and link text inside table cells after ./@,_- and at camelCase boundaries, only for tokens ≥16 chars. Render-time only, so the Markdown source, search index, llms-full.txt, and clipboard keep the plain token.
  • @types/hast dev dependency for the plugin's node types.

Result (Playwright, 1440×900, every table on the site)

Page Before After
Host capability matrix 190–709px on 6 tables 0px, except install surface 58px (5 columns × Rspress's 8rem cell minimum)
Event and hook matrix 152px 20px
Project structure, Runtime environment 59px, 47px 0px
Everything else (incl. 1,460 TypeDoc pages) 0px 0px

pnpm docs:site:build passes (typecheck, dead-link/anchor/image, language parity). No publishable package changes, so no changeset.

The host capability matrix scrolled up to 709px sideways at 1440px: its
per-host 'Plugin components' tables had 154 rows whose Detail column
held stringified JSON objects as single tokens, and Rspress's auto table
layout widens a column to its longest unbreakable token.

- Render each host's plugin components as Rspack-style reference
  sections: one heading per top-level capability group and one list
  entry per capability, with anchors and outline navigation instead of
  a three-column grid.
- Emit object-valued details as one `key.member: value` line each.
- Add a rehype plugin that inserts <wbr> into long code and link text
  inside table cells (after ./@,_- and at camelCase boundaries), so the
  remaining matrices (events, install surface, path tokens) fit the
  content column. The Markdown source, search index, llms-full.txt, and
  clipboard keep the plain token.
@changeset-bot

changeset-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: addf464

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 4, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-04T00:34:53.696098Z addf464 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@pkg-pr-new

pkg-pr-new Bot commented Sep 4, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle@490
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/create-agent-bundle@490
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/@agent-bundle/runtime@490

commit: addf464

@ScriptedAlchemy
ScriptedAlchemy merged commit dec0a05 into main Sep 4, 2026
20 of 21 checks passed
ScriptedAlchemy added a commit that referenced this pull request Sep 4, 2026
#502)

#490 removed `headers.detail` as unused; #480 landed concurrently and its
new lineage tables read it, so the main docs build failed to typecheck.
ScriptedAlchemy added a commit that referenced this pull request Sep 4, 2026
…n-dir load check; doctor reads enabled (AB7327) (#475, #476) (#504)

* fix(validate,build,doctor): run the Claude host validator and --plugin-dir load check from build and validate; doctor validates installed copies and reads enabled (#475, #476)

* test(packed-native): accept other hosts' informational reports in the packed Claude validation document

* docs(site): add the missing lineage-detail table header the generated reference plugin renders (#490 follow-up)

* chore(changeset): reference #504
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant