Skip to content

Conversation

DaedalusG
Copy link
Contributor

Problem

The technical changelog had malformed markdown code blocks that were breaking the rendering and making content unreadable. Specifically:

  1. PR #6220 entry: Had content incorrectly wrapped in a code block that should have been regular text
  2. Stray closing backticks: Extra ``` at the end of the file breaking markdown parsing

Solution

  • ✅ Removed incorrect code block formatting around PR #6220 description
  • ✅ Replaced with properly formatted bullet point explaining the change
  • ✅ Removed stray closing backticks at end of file
  • ✅ Preserved valid JSON code block for experimental features (this one was correctly formatted)

Testing

  • Verified all code blocks are now properly paired
  • Confirmed markdown structure is valid
  • No other formatting issues detected

Related

This is a manual fix for the immediate formatting issue. The root cause in the changelog generation tool will be addressed separately to prevent similar issues in future releases.

Fixes the formatting problems shown in the attached screenshots where code blocks were not closing properly.

- Remove incorrect code block formatting around PR #6220 description
- Replace with properly formatted bullet point
- Remove stray closing backticks at end of file
- Preserve valid JSON code block for experimental features

This fixes rendering issues where malformed markdown was breaking
the changelog display and making content unreadable.
Copy link

vercel bot commented Jul 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 24, 2025 7:17pm

@DaedalusG DaedalusG merged commit 9f51d4a into main Jul 24, 2025
5 checks passed
@DaedalusG DaedalusG deleted the wg/rel/changelog-gen-bug branch July 24, 2025 20:19
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.

2 participants