Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

[Bug]: Markdown generation discards content inside Tabs components

Ouverte
  • Quelque chose ne va pas ?
#4,063 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@manueldezman y travaille déjà.

Depuis le 18/8/2026.

  • #4080 par @manueldezman — ouverte

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
75/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Calme
Stack technique
markdown
Domaine
documentation

Piste de recherche

Commencez par src/pages/[...path].md.ts afin de suivre la route Markdown publique jusqu’à transformPageToMarkdown(), puis examinez src/lib/markdown/transformMarkdown.ts, en particulier la règle de nettoyage autour des lignes 211–224 et les handlers de composants existants. Préservez séquentiellement chaque libellé et chaque panneau de Tabs dans le Markdown généré, traitez les composants imbriqués comme CodeSample et ajoutez des tests confirmant que tout le contenu des onglets reste présent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
MDX
Étoiles
531
Forks
481
Merge moyen
1 j 7 h
PR mergées (30 j)
103

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de smartcontractkit/documentation

Toutes les issues de smartcontractkit/documentation

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.