Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[Bug]: Markdown generation discards content inside Tabs components

オープン
  • 何か問題がありますか？
#4,063 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
75/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
markdown
領域
documentation

調査の方向性

src/pages/[...path].md.ts から始めて、公開されている Markdown ルートを transformPageToMarkdown() までたどり、次に src/lib/markdown/transformMarkdown.ts を調べます。特に、211–224 行付近のクリーンアップルールと既存のコンポーネントハンドラーを確認してください。生成された Markdown では、各 Tabs のラベルとパネルを順番どおりに保持し、CodeSample などのネストされたコンポーネントを処理して、すべてのタブのコンテンツが残っていることを確認するテストを追加してください。

索引モデルが issue の本文から書いたものです。

説明

bug triage
Describe the bug

The generated .md pages omit content placed inside interactive Tabs components, creating content-parity differences between the rendered documentation and the agent-facing Markdown representation.

After previously documenting the affected pages in an agent experience audit, I encountered a similar parity issue in another documentation project. Investigating that project revealed a serialization problem, so I examined Chainlink's Markdown-generation pipeline for a comparable cause.

Chainlink's public .md route is implemented in:

src/pages/[...path].md.ts

The route reads the source MDX and passes it to transformPageToMarkdown(). The conversion logic is implemented in:

src/lib/markdown/transformMarkdown.ts

The transformer provides handlers for selected MDX components, including Aside, CodeSample, and CcipCommon. However, it does not provide a serialization handler for Tabs, TabsContent, or their slotted Fragment children.

The cleanup rule subsequently removes unsupported MDX flow components:

[transformMarkdown.ts, lines 211–224]
(https://github.com/smartcontractkit/documentation/blob/main/src/lib/markdown/transformMarkdown.ts#L211-L224)

Image

When a Tabs component is removed, its Fragment panels and their commands, tables, code samples, warnings, and expected outputs are removed with it.

For example, this source structure:

<Tabs client:visible>
  <Fragment slot="tab.1">Starter kit</Fragment>
  <Fragment slot="tab.2">Manual</Fragment>

  <Fragment slot="panel.1">
    Starter-kit instructions
  </Fragment>

  <Fragment slot="panel.2">
    Manual instructions
  </Fragment>
</Tabs>

produces a Markdown representation containing neither implementation path.

To Reproduce

  1. Open the rendered LockRelease Token Pool documentation page:
    https://docs.chain.link/ccip/tutorials/canton/cross-chain-tokens/lock-release-token-pool

  2. Navigate to Step 1: Deploy the LockRelease Token Pool.

  3. Confirm that the page contains Starter kit and Manual tabs with deployment instructions.

  4. Open the corresponding Markdown page:
    https://docs.chain.link/ccip/tutorials/canton/cross-chain-tokens/lock-release-token-pool.md

  5. Locate the same Step 1 section.

  6. Observe that the Markdown moves from the introductory paragraph directly to Transfer-fee fields, omitting both tab panels.

  7. Inspect the source MDX:
    https://github.com/smartcontractkit/documentation/blob/main/src/content/ccip/tutorials/canton/cross-chain-tokens/lock-release-token-pool.mdx

  8. Inspect the unsupported-component cleanup rule:
    https://github.com/smartcontractkit/documentation/blob/main/src/lib/markdown/transformMarkdown.ts#L211-L224

URLs

Representative page:

Expected behavior

The Markdown transformer should preserve every tab label and its corresponding panel content.

Because Markdown is not interactive, each tab could be serialized sequentially as a labeled section. Nested components, such as CodeSample, should then be processed by their existing handlers.

No tab panel should be silently discarded.

Additional context

All affected pages are documented here: https://github.com/manueldezman/chainlink-documentation-audit.

I would be happy to submit a focused PR that adds serialization support for Tabs, TabsContent, and their Fragment panels, along with automated tests confirming that every tab label and panel remains present in the generated Markdown.

主要言語
MDX
スター
528
フォーク
478
平均マージ
18時間 3分
マージ済み PR（30日）
85

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

smartcontractkit/documentation のほかの issue

smartcontractkit/documentation の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。