Skip to content

docs: fix broken admonition titles after Docusaurus version upgrade #344

@coderabbitai

Description

@coderabbitai

Tip

This issue hasn't been claimed yet. Comment /take if you'd like to work on it!


Summary

Following the Docusaurus version upgrade (PR #327: #327), admonitions that include a custom title are rendering incorrectly across the documentation site.

Problem

The admonition syntax for titled admonitions appears to have changed in the newer version of Docusaurus. As a result, titled admonitions are broken on all affected pages.

Example

A concrete example can be seen on the Setup & Dependencies page — specifically the "Docker Dev Environment" admonition defined at line 25 of docs/docs/contributing/setup-and-dependencies/index.md.

Requested Change

Audit all documentation pages for admonitions with custom titles and update their syntax to comply with the format expected by the currently installed version of Docusaurus.

Related

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions