Changelog Markdown is lossy: index.md.xml serves HTML, and index.md flattens tabs, captions, and callouts
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 64/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- markdown, typescript
- Área
- documentation
Línea de trabajo
Start with getEntryMarkdown and the changelog-related code in src/util/changelog.ts and src/util/rss.ts, then inspect the route that serves index.md.xml. Read renderEntryAsMarkdown on nimbus main at commit 3f1f58d and reproduce the listed feed and post examples. Done means the feed contains Markdown and post output preserves labels, callouts, code samples, package-manager flags, and removes decorative glyphs.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Example URL(s)
- https://developers.cloudflare.com/changelog/rss/index.md.xml
- https://developers.cloudflare.com/changelog/post/2026-09-28-cloudflare-cli-beta/index.md
- https://developers.cloudflare.com/changelog/post/2026-10-01-workers-oauth-provider-1x/index.md
Actual Behavior
/changelog/rss/index.md.xmlserves HTML.index.md.xml.tscalls the samegetRSSItems()as the HTML feed; the header ofsrc/util/changelog.tsnotes the Markdown variant was not ported to Nimbus.- Post
index.mdoutput (Markdown for Agents conversion of the rendered HTML) loses component meaning: package-manager tabs becomenpmyarnpnpmbunplus four unlabeled code blocks, code captions become*src/index.jsjs*, JS/TS examples appear twice unlabeled, callouts become a bareNoteline, and links keep the↗︎glyph.
Expected Behavior
The Markdown feed contains Markdown, and post Markdown keeps component meaning: one labeled command block, one TypeScript sample, labeled callouts, no decorative glyphs.
Additional information
getEntryMarkdown from @cloudflare/nimbus-docs/runtime produces clean Markdown for these posts and could back index.md.xml (about 40 lines in src/util/changelog.ts, src/util/rss.ts, and the route; I can open a PR). On nimbus main (3f1f58d), renderEntryAsMarkdown has three gaps that affect it:
- top-level MDX
importlines are emitted verbatim :::noteadmonitions stay as raw directive syntax<PackageManagers … global />drops the global flag (npm i cfinstead ofnpm install --global cf)
- Lenguaje dominante
- MDX
- Estrellas
- 5.4k
- Forks
- 17.3k
- Merge medio
- 1 d 20 h
- PR fusionados (30 d)
- 525
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de cloudflare/cloudflare-docs
-
BIMI records for DNSPosiblemente ocupada @ayushkrsingh946 la tomó hace 6 días. Abiertocontent:new documentation effort:very-high
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
cloudflare/cloudflare-docs#34744 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
effort:medium engineering
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
cloudflare/cloudflare-docs#34619 ·
Los mantenedores suelen responder en 1 día
-
Incorrect local link is used in Stream documentationPosiblemente ocupada @AiAlchemist0 la tomó hace 12 días. Abiertoeffort:medium engineering
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
cloudflare/cloudflare-docs#34497 ·
Los mantenedores suelen responder en 1 día
-
meeting.chatSynced bugAbiertoeffort:medium engineering
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
cloudflare/cloudflare-docs#34464 ·
Los mantenedores suelen responder en 1 día
-
content:edit documentation effort:high
Dificultad 1/5 1-3 horas Aptitud para principiantes 67/100
cloudflare/cloudflare-docs#34428 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de cloudflare/cloudflare-docs
Issues similares
-
docs(reference): pi stream-filter bullet says tool_execution_update passes through unchangedAbiertoagent-butler-finding bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
jordansmall/spindrift#6391 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
spdx/license-list-XML#3104 ·
-
Broken links in the docsAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Windows docs: pin a tested ConPTY version for Kitty graphics; 1.25.260930003 corrupts large uploadsAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
raphamorim/rio#2021 ·
Los mantenedores suelen responder en 1 día
-
sync-en
Dificultad 1/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día