Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Bug]: Markdown generation discards content inside Tabs components

Aperta
  • Qualcosa non va?
#4,063 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
75/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia da src/pages/[...path].md.ts per seguire la route Markdown pubblica fino a transformPageToMarkdown(), quindi esamina src/lib/markdown/transformMarkdown.ts, in particolare la regola di pulizia intorno alle righe 211–224 e gli handler dei componenti esistenti. Mantieni sequenzialmente ogni etichetta e pannello di Tabs nel Markdown generato, elabora i componenti annidati come CodeSample e aggiungi test che confermino che tutto il contenuto delle schede rimanga presente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
MDX
Stelle
528
Fork
478
Merge medio
18h 3m
PR unite (30g)
85

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di smartcontractkit/documentation

Tutte le issue di smartcontractkit/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.