docs(main): fix changelog header inlining bug

[Prachi-Gupta2808]

Changes & Reason

Changes

• Fixed consolidatedFile.js
• Changed RELEASES: sections to RELEASES: sections.join("\n\n")

Reason

• Prevents array-to-string conversion issues causing broken MDX headings
• Ensures proper release section formatting in changelog output

Related Issues

Fixes: #468

Testing & Verification

• Checked changelog rendering for multiple releases
• Verified correct heading separation (no inline/comma output)

Additional Resources

N/A

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 401eaf55-33fc-4bb3-b149-db5a465a9f25

📥 Commits

Reviewing files that changed from the base of the PR and between 282e1e6 and 63de555.

📒 Files selected for processing (1)

• docs/plugins/changelogPlugin/generators/consolidatedFile.js

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{js,ts,jsx,tsx}

📄 CodeRabbit inference engine (.editorconfig)

**/*.{js,ts,jsx,tsx}: Use 2-space indentation for JavaScript and TypeScript files
Maintain 200 character maximum line length for JavaScript/TypeScript files

Files:

• docs/plugins/changelogPlugin/generators/consolidatedFile.js

**

⚙️ CodeRabbit configuration file

**: # Contributing to Img2Num

Want to contribute to Img2Num? There are a few things you need to know.

We wrote a contribution guide to help you get started.

A few important points:

• Add tests with your PR — new features and bug fixes must include tests where appropriate. PRs without tests are unlikely to be approved.
• Follow the repository's coding style rules.
• Use the issue and PR templates when filing issues or submitting code. Your PR will be rejected if you don't.

If you're unsure what to change, open a discussion and someone will assist you.

Questions?

If you have questions or need help:

• Open a discussion
• Create an issue
• Check existing PRs for ideas

Thank you for improving Img2Num! 🎨🚀

**: BasedOnStyle: LLVM
Standard: c++20

--- Basic formatting ---

IndentWidth: 4
ColumnLimit: 100
TabWidth: 4

--- Braces ---

Cpp11BracedListStyle: true
SpaceBeforeCpp11BracedList: true
BreakBeforeBraces: Attach

--- Braced initializers ---

Cpp11BracedListStyle: true

--- Constructor initializer lists ---

PackConstructorInitializers: Never
BreakConstructorInitializers: BeforeComma
ConstructorInitializerIndentWidth: 4

--- Alignment ---

AlignAfterOpenBracket: BlockIndent

--- Pointers ---

PointerAlignment: Left

--- Includes ---

IncludeBlocks: Regroup
SortIncludes: CaseInsensitive

--- Extern "C" cleanliness ---

IndentExternBlock: NoIndent

--- Lambdas ---

AllowShortLambdasOnASingleLine: Inline

--- Functions ---

AllowShortFunctionsOnASingleLine: None

**: root = true

-------------------------

Global defaults

-------------------------

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
max_line_lengt...

Files:

• docs/plugins/changelogPlugin/generators/consolidatedFile.js

docs/**/*.{js,jsx,ts,tsx,mdx}

⚙️ CodeRabbit configuration file

docs/**/*.{js,jsx,ts,tsx,mdx}: This is the Docusaurus site source. Check for MDX compatibility, correct
plugin usage, and valid imports. Review docusaurus.config.js changes carefully
for broken routing or plugin config regressions.

Files:

• docs/plugins/changelogPlugin/generators/consolidatedFile.js

🔇 Additional comments (1)

docs/plugins/changelogPlugin/generators/consolidatedFile.js (1)

2-5: LGTM!

Also applies to: 31-31

---

• Fixed the consolidated changelog generator so RELEASES is passed to the MDX template as a single formatted string instead of a raw array, preserving proper release heading spacing and rendering.
• This resolves malformed consolidated changelog output when a CHANGELOG.md contains multiple releases.

Contributing author	Lines added	Lines removed
PR author	3	3

Walkthrough

In consolidatedFile.js, the RELEASES variable passed to the MDX template is changed from the raw sections array to a single string produced by joining elements with "\n---\n" separators. Import order at the top of the file is also reordered.

Changes

Changelog Section Joining Fix

Layer / File(s)	Summary
consolidatedFile.js sections join docs/plugins/changelogPlugin/generators/consolidatedFile.js	RELEASES passed to the MDX template is now sections.join("\n---\n") instead of the raw array; imports are reordered.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

• #468 (docs(main): fix consolidated changelog header inlining bug) — This PR directly addresses the malformed headings bug by fixing how release sections are joined before being passed to the consolidated changelog template.
• #467 — Also targets the consolidated changelog generator/template data flow for multiple releases, which overlaps with this fix.

🐇 A little dash here, a join there,
Sections now flow without a care.
No more headings lost in line,
The changelog renders just fine!
Hops of joy for "\n---\n"! 🎉

🚥 Pre-merge checks | ✅ 7 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (7 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is specific, uses a Conventional Commit-style prefix, and matches the changelog header fix.
Description check	✅ Passed	The description clearly relates to the changelog generator fix and the malformed heading issue.
Linked Issues check	✅ Passed	The change addresses issue #468 by changing the consolidated changelog generator to render release sections as formatted text instead of an array.
Out of Scope Changes check	✅ Passed	The only extra change is an import reorder, which is minor and not out of scope.
No Ai Slop Pr Description	✅ Passed	The PR description names the exact code change and the bug it fixes, with no generic boilerplate dominating the text.
No Strangely-Named Root Markdown Files	✅ Passed	No unconventional markdown files exist at the repository root; only README.md, CONTRIBUTING.md, and CODE_OF_CONDUCT.md are present.
Coderabbit Config Needs Update	✅ Passed	Only docs JS/MDX code changed; .coderabbit.yaml already covers docs/**/*.{js,jsx,ts,tsx,mdx} and eslint, so no update is needed.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Ryan-Millard]

Great stuff! Thank you!🦔

[Prachi-Gupta2808]

Hi @Ryan-Millard and @Krasner , I know that I probably shouldn't ask this but what do you guys do? Are you both students or working professionals? I was wondering this while coding today when I had one assignment due and I just wanted to ask you guys. If you both are okay to answer this ofcourse

[Ryan-Millard]

Hi @Ryan-Millard and @Krasner , I know that I probably shouldn't ask this but what do you guys do? Are you both students or working professionals? I was wondering this while coding today when I had one assignment due and I just wanted to ask you guys. If you both are okay to answer this ofcourse

Right now, I'm a student and a software engineer.

I started this project because I wasn't taught C++ at all in university and really wanted to learn it, but I also didn't want to use the GUI libraries that C++ has because they're a pain to set up and use (I didn't want to learn Conan and submodules are terrible to maintain - we only have one in third_party/). Additionally, I wanted to challenge myself by bringing low-level code to the web, so I researched ways to run C++ in browsers. The main purpose of this was to teach me things and have fun with computer vision.

[Krasner]

Hi @Ryan-Millard and @Krasner , I know that I probably shouldn't ask this but what do you guys do? Are you both students or working professionals? I was wondering this while coding today when I had one assignment due and I just wanted to ask you guys. If you both are okay to answer this ofcourse

Right now, I'm a student and a software engineer.

I started this project because I wasn't taught C++ at all in university and really wanted to learn it, but I also didn't want to use the GUI libraries that C++ has because they're a pain to set up and use (I didn't want to learn Conan and submodules are terrible to maintain - we only have one in third_party/). Additionally, I wanted to challenge myself by bringing low-level code to the web, so I researched ways to run C++ in browsers. The main purpose of this was to teach me things and have fun with computer vision.

I work in AI but wanted a fun project to practice C++. I do a lot of python and some C++ for embedded applications but generally I spend much less time in C++ than I'd like, so any opportunity to practice is welcome. I also have little patience so optimizing the repo and including webgpu really helped make things run a lot faster.

[Prachi-Gupta2808]

It's very nice to know about you both, thank you for sharing!
I am a student currently too and I initially started open source because I wanted to apply for LFX and Gsoc etc and start preparing from now only, but in a last few days, I actually really like doing this. Seeing projects and working with people, learning new things. I am enjoying this.

If you both know any other project where I can contribute and which uses c++, Js, node etc, please do share the repo links with me! I'll really appreciate them.

[Ryan-Millard]

Hi @Ryan-Millard and @Krasner , I know that I probably shouldn't ask this but what do you guys do? Are you both students or working professionals? I was wondering this while coding today when I had one assignment due and I just wanted to ask you guys. If you both are okay to answer this ofcourse

Right now, I'm a student and a software engineer.
I started this project because I wasn't taught C++ at all in university and really wanted to learn it, but I also didn't want to use the GUI libraries that C++ has because they're a pain to set up and use (I didn't want to learn Conan and submodules are terrible to maintain - we only have one in third_party/). Additionally, I wanted to challenge myself by bringing low-level code to the web, so I researched ways to run C++ in browsers. The main purpose of this was to teach me things and have fun with computer vision.

I work in AI but wanted a fun project to practice C++. I do a lot of python and some C++ for embedded applications but generally I spend much less time in C++ than I'd like, so any opportunity to practice is welcome. I also have little patience so optimizing the repo and including webgpu really helped make things run a lot faster.

What kinds of embedded projects do you work on?

[Ryan-Millard]

It's very nice to know about you both, thank you for sharing! I am a student currently too and I initially started open source because I wanted to apply for LFX and Gsoc etc and start preparing from now only, but in a last few days, I actually really like doing this. Seeing projects and working with people, learning new things. I am enjoying this.

If you both know any other project where I can contribute and which uses c++, Js, node etc, please do share the repo links with me! I'll really appreciate them.

The project below welcomes newcomers, but it requires special hardware, so I'd probably need to make a plan with the maintainers to get it to you since it's mainly based in South Africa and distributing small-scale hardware is a bit difficult.

I've been working with some engineers on Kijani for about a year now. It's an ESP32-based robot platform that was created because they wanted to make robots cheaper as well as share their love for technology. It's still in development because troubleshooting hardware and software is quite difficult. Previously, the work wasn't published to GitHub and we only started having an online and open presence recently (it's difficult to convince telecommunications and electrical engineers to change their ways😂).

There is definitely a lot that needs to be done on the software side of things.

[Krasner]

What kinds of embedded projects do you work on?

I work for a retinal imaging company so I developed a real-time pupil tracking algo for nvidia jetson. Used TensorRT and c++ and some custom cuda kernels to deploy a deep learning model.
Have you used GStreamer before for video processing? Thats what I built on top of.

I used to do a lot of FPGA development maybe 7 years ago but I'm pretty rusty on that now.

[Ryan-Millard]

What kinds of embedded projects do you work on?

I work for a retinal imaging company so I developed a real-time pupil tracking algo for nvidia jetson. Used TensorRT and c++ and some custom cuda kernels to deploy a deep learning model. Have you used GStreamer before for video processing? Thats what I built on top of.

I used to do a lot of FPGA development maybe 7 years ago but I'm pretty rusty on that now.

That explains a lot about your technical expertise.

Also, I haven't done anything practical in computer vision outside of this project. It's just not in demand in South Africa.

[Prachi-Gupta2808]

What kinds of embedded projects do you work on?

I work for a retinal imaging company so I developed a real-time pupil tracking algo for nvidia jetson. Used TensorRT and c++ and some custom cuda kernels to deploy a deep learning model. Have you used GStreamer before for video processing? Thats what I built on top of.

I used to do a lot of FPGA development maybe 7 years ago but I'm pretty rusty on that now.

That is so cool 😭 One of my professors did his PhD in Sweden and he was telling about computer vision in class. Really makes me feel like a whole new world whenever I hear people talking about it.