Skip to content

ci(docs) Lead symbol links with their kind badge - #798

Merged
tony merged 1 commit into
docs-site-deployfrom
docs-publisher-464891319
Oct 29, 2026
Merged

tony merged 1 commit into
docs-site-deployfrom
docs-publisher-464891319

Conversation

@tony

@tony tony commented Oct 29, 2026

Copy link
Copy Markdown
Member

Pin only the shared port builder and publisher to 4648913190eb75e4b592db2ba14e15fdcf24174f from e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e. All other workflow bytes, library contents, triggers, permissions and language/source/version inputs remain unchanged.

  • Lead a cross-reference in an API doc comment with the kind badge of the declaration it names, the first time an entry mentions that declaration; a later mention is the link alone and keeps its kind in the tooltip and the accessible name (ApiDoc.astro, ApiEntry.astro)

  • Lead a tmux command, option, hook or format variable named in a doc comment with its tmux kind badge, whether it is named in prose or is the only name in a code span, under the same first-mention rule (tmux-links.ts)

  • Exclude the kind badge from search text, for a guide mention and for a doc-comment cross-reference, so search does not read its mark as the first letter of the name beside it (mention-badge.ts)

  • Lead a module, package or namespace named in a code span of a guide with its module kind badge, the first time a section mentions it; a later mention keeps its kind in the tooltip and the accessible name (rehype-api-links.ts)

  • Lead each entry of the Workspace Manager and MCP reference index with its kind badge, so the list shows the kind of each declaration (ProductApiIndex.astro)

  • Exclude the kind badge that leads a link in an MCP tool description from search text as well (mcp-reference.ts)

  • Lead a code cross-reference on Python's native Sphinx pages with the kind badge of its target's declaration the first time a section mentions it, and let a later mention keep its kind in the tooltip and the accessible name; a property referenced as an attribute reads as a property and an exception referenced as a class reads as an exception, a target with no declaration, a link to another site and a signature stay plain, and a page that cannot be marked keeps its navigation (native-xrefs.ts, native-shell-context.mjs, NativeSphinxScript.astro)

A cross-reference in an API doc comment gave no sign of the kind of declaration it named, though a mention of the same name in a guide already led with a kind badge. Search also read the mark of that badge as part of the name beside it, so a name could be indexed with a stray letter.

The exact required CI and root merge receipts of the shared checkpoint must be verified before this operator runs. This PR does not claim an owner build or publication pass. Root reviews this exact caller diff, actual repository-required checks and reviews before merge; optional native estate checks are not a new universal gate.

Execution route: exact_source_manual_dispatch_after_root_controlled_pin_merge. Root separately schedules reviewed merges and exact source requests from the actual workflow state. If the current active workflow already publishes the intended source on merge, retain that actual event and do not issue a duplicate request. Future source/native/run identities will be bound to actual events.

why: A cross-reference in an API doc comment gave no sign of the kind of
declaration it named, though a mention of the same name in a guide
already led with a kind badge. Search also read the mark of that badge
as part of the name beside it, so a name could be indexed with a stray
letter.

what:
- Lead a cross-reference in an API doc comment with the kind badge of
  the declaration it names, the first time an entry mentions that
  declaration; a later mention is the link alone and keeps its kind in
  the tooltip and the accessible name (`ApiDoc.astro`, `ApiEntry.astro`)
- Lead a tmux command, option, hook or format variable named in a doc
  comment with its tmux kind badge, whether it is named in prose or is
  the only name in a code span, under the same first-mention rule
  (`tmux-links.ts`)
- Exclude the kind badge from search text, for a guide mention and for a
  doc-comment cross-reference, so search does not read its mark as the
  first letter of the name beside it (`mention-badge.ts`)
- Lead a module, package or namespace named in a code span of a guide
  with its module kind badge, the first time a section mentions it; a
  later mention keeps its kind in the tooltip and the accessible name
  (`rehype-api-links.ts`)
- Lead each entry of the Workspace Manager and MCP reference index with
  its kind badge, so the list shows the kind of each declaration
  (`ProductApiIndex.astro`)
- Exclude the kind badge that leads a link in an MCP tool description
  from search text as well (`mcp-reference.ts`)
- Lead a code cross-reference on Python's native Sphinx pages with the
  kind badge of its target's declaration the first time a section
  mentions it, and let a later mention keep its kind in the tooltip and
  the accessible name; a property referenced as an attribute reads as a
  property and an exception referenced as a class reads as an exception,
  a target with no declaration, a link to another site and a signature
  stay plain, and a page that cannot be marked keeps its navigation
  (`native-xrefs.ts`, `native-shell-context.mjs`,
  `NativeSphinxScript.astro`)

Shared source: libtmux/docs
From: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
To:   4648913190eb75e4b592db2ba14e15fdcf24174f
@codecov

codecov Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.37%. Comparing base (d2af39f) to head (c5b8c1c).

Additional details and impacted files
@@                Coverage Diff                @@
##           docs-site-deploy     #798   +/-   ##
=================================================
  Coverage             52.37%   52.37%           
=================================================
  Files                    26       26           
  Lines                  3729     3729           
  Branches                747      747           
=================================================
  Hits                   1953     1953           
  Misses                 1472     1472           
  Partials                304      304           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tony
tony merged commit f8f4cd5 into docs-site-deploy Oct 29, 2026
16 checks passed
@tony
tony deleted the docs-publisher-464891319 branch October 29, 2026 23:38
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