Skip to content

Conversation

@TabishB
Copy link
Contributor

@TabishB TabishB commented Jan 20, 2026

Summary

  • Fixes bad rendering of changelog entries where markdown headers (### New Features) were nested inside list items
  • Converts all affected entries to use **Bold Text** instead, which renders correctly in the list item context
  • Adds brief summary lines to each entry for better readability

Problem

Changesets formats descriptions as list item continuations. When descriptions contain markdown headers, they get nested incorrectly:

- [#530](...) Thanks [@TabishB]! - ### New Features    ← header inside a list item

  - **Feature** — description                          ← everything indented

Solution

Replace ### Header with **Header** which renders properly as bold text within the list context.

Test plan

  • Verify CHANGELOG.md renders correctly on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Reorganized and reformatted changelog entries for improved readability and consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

…atting

Changeset descriptions that use markdown headers (### New Features) get
nested inside list items, causing poor rendering. This converts all
affected entries to use **Bold Text** instead, which renders correctly.

Also adds a brief summary line to each entry for better readability.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 20, 2026

📝 Walkthrough

Walkthrough

CHANGELOG.md undergoes structural reorganization where explicit "### New Features" headings are replaced with inline bullet-style entries describing features like project-level configuration, project-local schemas, and schema management commands across multiple version sections (0.22.0, 0.21.0, 0.20.0, 0.19.0). Formatting and surrounding headers are adjusted for consistency.

Changes

Cohort / File(s) Summary
Documentation Reorganization
CHANGELOG.md
Restructured 0.22.0 Minor Changes entries from explicit section headings to inline bullet-style descriptions; adjusted header formatting and clarified feature entries across versions 0.21.0–0.22.0 including feedback command, Nix flake support, and schema management features

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #516: Introduced v0.21 features (feedback command, Nix flake support) that are being restructured and clarified in this changelog reorganization

Poem

📋 A rabbit hops through changelog lines,
Reshuffling features, refining designs,
Bullets now shine where headers once were—
Cleaner, neater—no feature will blur! 🐰✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: converting markdown headers to bold text for proper formatting in the CHANGELOG.md file, which aligns with the changeset's primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

@greptile-apps
Copy link

greptile-apps bot commented Jan 20, 2026

Greptile Summary

Fixes changelog rendering by replacing markdown headers with bold text formatting in list item contexts.

Changes Made:

  • Converted <h4>New Features, `

Bug Fixes`, `

Other`, and `

Documentation` headers to `**Bold Text**` format in 6 affected changelog entries (versions 0.22.0, 0.21.0, 0.20.0, 0.19.0, and 0.17.0)

- Added concise summary lines immediately after PR links for better readability (e.g., "Add project-level configuration, project-local schemas, and schema management commands") - Preserved all content and list structure, only changing header formatting

Why This Matters:
Changesets formats descriptions as list item continuations. When markdown headers (<h4>) are nested inside list items, they render incorrectly with broken indentation. Using **Bold** instead renders properly within the list context while maintaining visual hierarchy.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • The changes are purely cosmetic formatting fixes to improve markdown rendering. No logic, dependencies, or functionality are affected. The fix correctly addresses the nesting issue by using bold text instead of headers within list items. All content remains identical, only the formatting syntax changed.
  • No files require special attention

Important Files Changed

Filename Overview
CHANGELOG.md Formatting fix: converted markdown headers to bold text for proper rendering in list items, added summary lines for clarity

Sequence Diagram

sequenceDiagram
    participant Author
    participant Changesets
    participant GitHub
    participant Reader

    Author->>CHANGELOG.md: Write markdown headers (### New Features)
    Note over CHANGELOG.md: Headers nested in list items
    Changesets->>CHANGELOG.md: Format as list item continuation
    CHANGELOG.md->>GitHub: Render markdown
    GitHub->>Reader: Display incorrectly nested headers
    
    Note over Author,Reader: FIX APPLIED
    
    Author->>CHANGELOG.md: Replace ### with **Bold**
    Author->>CHANGELOG.md: Add summary lines
    CHANGELOG.md->>GitHub: Render markdown
    GitHub->>Reader: Display properly formatted bold text
Loading

@TabishB TabishB merged commit d61a49f into main Jan 20, 2026
10 checks passed
@TabishB TabishB deleted the fix/changelog-formatting branch January 20, 2026 08:09
StrayDragon pushed a commit to StrayDragon/OpenSpec that referenced this pull request Jan 20, 2026
…atting (Fission-AI#532)

Changeset descriptions that use markdown headers (### New Features) get
nested inside list items, causing poor rendering. This converts all
affected entries to use **Bold Text** instead, which renders correctly.

Also adds a brief summary line to each entry for better readability.
harikrishnan83 added a commit to intent-driven-dev/OpenSpec that referenced this pull request Jan 21, 2026
# By Tabish Bidiwale (57) and others
# Via GitHub
* main: (67 commits)
  fix(ci): use workflow_dispatch for polish release notes (Fission-AI#533)
  fix(changelog): convert markdown headers to bold text for proper formatting (Fission-AI#532)
  Version Packages (Fission-AI#531)
  Add changeset for project config and schema commands (Fission-AI#530)
  fix(config): handle null rules field in project config (Fission-AI#529)
  docs: update workflow docs and mark schema commands as experimental (Fission-AI#526)
  feat(cli): add schema management commands (Fission-AI#525)
  fix: Windows path compatibility in resolver tests (Fission-AI#524)
  change(schema-management-cli): proposal for schema management commands (Fission-AI#523)
  feat(resolver): add project-local schema support (Fission-AI#522)
  docs: add project-config demo guide (Fission-AI#521)
  feat(config): add project-level configuration via openspec/config.yaml (Fission-AI#499)
  fix: auto-trigger polish release notes on release publish (Fission-AI#519)
  perf: add path filtering to Nix validation CI job (Fission-AI#518)
  Version Packages (Fission-AI#517)
  Add changeset for v0.21 release (Fission-AI#516)
  fix: prevent implementation during explore mode (Fission-AI#515)
  OPSX apply: infer target change (Fission-AI#513)
  Refine opsx archive sync assessment (Fission-AI#514)
  feat: add nix flake support (sorry for this duplicate) (Fission-AI#459)
  ...

# Conflicts:
#	src/core/templates/slash-command-templates.ts
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