Skip to content

Bug: Documentation Formatting Issue for sonic-utilities Command-Reference.md #24696

@Bojun-Feng

Description

@Bojun-Feng

Is it platform specific

generic

Importance or Severity

Low

Description of the bug

Unindented line inside an indented code block breaks Markdown documentation parsing and inverts code/non-code rendering from that point onward.

Steps to Reproduce

Click on the following link:

https://github.com/sonic-net/sonic-utilities/blob/70926dd50c1c39d88e24ca8efaf0a99724569785/doc/Command-Reference.md#:~:text=add%20all%20Ethernet20-,Suppose%20vlan%20100%2C%20vlan%20101%2C%20vlan%20102%2C%20vlan%20103%2C%20vlan%20104,05,-**config%20proxy_arp%20enabled

Verify that from the given line on all code blocks are reversed. All code blocks are rendered as normal text and all normal text are rendered as code blocks.

Actual Behavior and Expected Behavior

Doc file rendering screenshot, actual and expected

Actual:

after2



Expected:

before2

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions